Ratio ESL

Ratio ESL support in Python.

Developer guide

Versioning

This project uses semantic versioning. Version increments are checked using Raver.

Python packaging information

This project is packaged using poetry. Packaging information as well as dependencies are stored in pyproject.toml.

Installing the project and its dependencies can be done using poetry install.

Building the project (creating a wheel and sdist) can be done using poetry build.

Testing

The tests need to be put in the tests/ directory or as doctests in docs/ in the documentation and can be run using pytest on both Windows and Linux as long as pytest and pytest-cov are installed in the active Python environment. Running pytest in the tests directory works as well.

Make sure the correct environment is activated!

Documentation

Building the documentation (in HTML) can be done using cd docs && make clean html && cd ... The documentation is then built locally at docs/build using sphinx.