File tree Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change 11Contributing
22============
33
4- This package uses the pyTest test runner. To run the tests locally simply run::
4+ Before you start editing the python code, you will need to make sure
5+ you have binary dependencies installed::
56
6- python setup.py test
7+ # Debian
8+ sudo apt install -y gettext graphviz google-chrome-stable
9+ # macOS
10+ brew install -y gettext graphviz google-chrome-stable
711
8- If you need to the development dependencies installed of you local IDE, you can run::
12+ To install the package and its dependencies for development
13+ including tests dependencies, please do:
914
10- python setup.py develop
15+ python -m pip install -e .[test]
16+
17+ You may ran the tests via::
18+
19+ python -m pytest
1120
1221Documentation pull requests welcome. The Sphinx documentation can be compiled via::
1322
14- python setup.py build_sphinx
23+ python -m pip install -e .[docs]
24+ python -m sphinx -W -b doctest -b html docs docs/_build
1525
1626Bug reports welcome, even more so if they include a correct patch. Much
1727more so if you start your patch by adding a failing unit test, and correct
You can’t perform that action at this time.
0 commit comments