CONTRIBUTING.md

How-to contribute to Delair.ai Python SDK

Running unit tests

Unit tests are written with the unittest module (compatible with pytest):

$ python3 -m pip install -e .[tests]
$ python3 -m pip install -e .[coverage]
$ pytest --cov delairstack --cov-report term --cov-report html

Documentation

Building the documentation requires pandoc.

1. First install the dependencies:

   $ python3 -m pip install -e .[documentation]

2. Build the documentation:

   $ cd docs
   docs$ make html

   The generated documentation can be browsed opening the file docs/_build/html/index.html in a web browser.

3. (Optional) Automatic build while editing intensively the documentation

   docs$ python3 -m pip install sphinx-autobuild
   docs$ sphinx-autobuild docs _build/html