Contributing

If you find a bug or have a feature request, please open an issue on [GitHub](https://github.com/gioelecrispo/chunkipy/issues). Contributions are welcome! Just fork the repository, create a new branch with your changes, and submit a pull request. Please make sure to write tests for your changes and to follow the [code style](https://www.python.org/dev/peps/pep-0008/).

Development

To start developing chunkipy, it is recommended to:

Create a virtual environment (e.g. python -m venv .venv) and activate it
Install poetry via pip install poetry
Install the development dependencies via one of these commands:

Documentation

chunkipy relies on python docstrings and sphinx for its documentation. sphinx-autosummary is used to automatically generate documentation from code.

sphinx-multiversion is used to provide multiversion support, i.e. you can navigation documention for past version too.

This is handled via Github Action, but you can reproduce it by installing the needed dependencies:

and then by running the following command:

Testing

We use pytest as main testing framework. You can install al the testing dependencies by running:

Once done, you can run all the unit test (and check the coverage) with this command from the project folder: