Development - Contributing¶

Developing¶

If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.

You should have at least Python 3.7.

This site is configured with Poetry to build, package, and publish the docs.

You can learn how to install it in the Poetry docs.

After having Poetry available, you can install the development dependencies:

$ poetry install

---> 100%

It will also create a virtual environment automatically and will install all the dependencies in it.

To use your current environment, and to have access to all the tools in it (for example pytest for the tests) enter into a Poetry Shell:

$ poetry shell

That will set up the environment variables needed dand will start a new shell with them.

The documentation uses MkDocs with Material for MkDocs.

All the documentation is in Markdown format in the directory ./docs.

Many of the tutorials have blocks of code.

In most of the cases, these blocks of code are actual complete applications that can be run as is.

In fact, those blocks of code are not written inside the Markdown, they are Python files in the ./docs_src/ directory.

And those Python files are included/injected in the documentation when generating the site.

Thanks for contributing! ☕