Contribute

Please feel free to contribute to the project by submitting bug reports and/or pull requests at tidytcells’ GitHub repository!

Setting up a development environment

To set up a development environment for tidytcells, please clone the git repository linked above, and then set up a virtual environment by executing the following commands:

$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -e .[dev]

This will set up a python virtual environment in which an editable copy of the tidytcells package (changes in the source code will be reflected in real time), plus the development dependencies (currently pytest and pytest-cov) will be installed.

Running tests

From inside the development environment set up above, you can run test code by executing:

$ python -m pytest

If you want to also see test coverage, run instead:

$ python -m pytest --cov=src