Development environment¶

This page contains some guidelines to set up your environment to contribute to the project.

Install package for development¶

Packaging and organization of the library is done using Poetry

poetry install

This will install both dependencies needed for the library and for the development of the library.

Quality and tests can be run using tasks. To obtain the full list:

poetry run inv --list

Code is formated using Black. To run it:

poetry run inv quality.black-format

Documentation style is checked using pydocstyle. To run it:

poetry run inv quality.docstyle

Finally linting is done with Flake8. To run it:

poetry run inv quality.lint

To run all the unit tests you can use the following command from the root of the project:

poetry run inv tests.unit

Note

-s and -v options are used to get more details about the tests and redirect all output to stdout.

You can also only run selected tests by specifying the name of the test file:

poetry run pytest -s -v tests/dabeplech/parsers/

Note

You can find more information in the pytest documentation.