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 will be installed.

Running tests

The following commands should be run from the testing environment set up as per above.

To run the complete suite of tests including the test building of the sphinx docs and pytest tests on multiple python versions, you can use tox:

$ tox

To execute just the pytest unit tests, run:

$ python -m pytest

If you want to also see test coverage, run:

$ python -m pytest --cov=src