Commit 1e48c82a authored by Vasilis Tsiligiannis's avatar Vasilis Tsiligiannis
Browse files

docs: Mention installation of 'tox', describe 'tox' environments

Signed-off-by: Vasilis Tsiligiannis's avatarVasilis Tsiligiannis <>
parent 47388475
......@@ -61,6 +61,30 @@ Automation
``tox`` is used to automate development tasks.
To install ``tox`` run::
$ pip install tox
To execute the default list of tasks run::
$ tox
The following ``tox`` environments are available:
* ``flake8`` - Check code for common errors, coding style and complexity
* ``isort`` - Check code for correct imports order
* ``isort-apply`` - Sort imports
* ``yapf`` - Check code for correct formatting
* ``yapf-apply`` - Reformat source code
* ``pylint`` - Execute static code analysis
* ``build`` - Build source and binary distributions
* ``upload`` - Upload source and binary distributions to PyPI
* ``docs`` - Build documentation
To execute a single environment run::
$ tox -e <environment>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment