Local Development & Testing

Installation for Development¶

To set up the project for development, clone the repository and install it along with the dev extra dependencies:

git clone https://github.com/gambitproject/gtdraw
cd gtdraw
pip install -e ".[dev]"

You’ll also need to follow the rest of the steps on the installation page for LaTeX and other requirements.

Testing¶

The project includes a comprehensive test suite using pytest.

To run all tests:

pytest tests/ -v

To run tests with coverage reporting:

pytest tests/ --cov=gtdraw --cov-report=html

Releases¶

To release a new version of gtdraw:

1. Update the version number in pyproject.toml.

2. Update the version number in src/gtdraw/__init__.py.

3. Create a pull request targeting the main branch with the changes.

4. Once the pull request is approved and merged, update your local main branch:

   git checkout main
   git pull origin main

5. Create and push a new tag corresponding to the version:

   git tag vX.X.X
   git push origin tag vX.X.X

6. Finally, create a new Release on GitHub based on the pushed tag.