Skip to content

Update development instructions #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adorilson wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update development instructions #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a57460
Doc: Replace requirements.txt by requirements-dev.txt as development …
adorilson Sep 8, 2025
deed2fc
Doc: Replace setup.py by `tox run`
adorilson Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Installing Dependencies

Install development dependencies with `pip <http://www.pip-installer.org/>`_::

$ pip install -r requirements.txt
$ pip install -r requirements-dev.txt

All packages for running tests and building documentation will be installed.

Expand All @@ -65,11 +65,10 @@ Python:
* CPython 3.5
* CPython 3.6

Testing uses `tox <https://pypi.python.org/pypi/tox>`_. If you don't want to
install all the development requirements, then, after downloading, you can
Testing uses `tox <https://pypi.python.org/pypi/tox>`_. You can
simply run::

$ python setup.py test
$ tox run

The test argument to setup.py will download a minimal testing infrastructure
and run the tests.
Besides run the tests, it will perform other tasks, such as runs linters and
formatters against the source-code, and build the docs.