Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?

  • Which version of this project are you using?

  • What did you do?

  • What did you expect to see?

  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

You need to have Python 3.10, 3.11, 3.12, 3.13, 3.13t, 3.14, 3.14t installed. With uv, you can easily install and manage multiple Python versions:

$ uv python install 3.10 3.11 3.12 3.13 3.13t 3.14 3.14t

Note: uv will be installed automatically when you run the commands above. Alternatively, you can install uv manually by following the instructions on the official website. This project requires uv version 0.9.2 or higher. You can verify your version with uv --version.

Install dependencies:

$ uv sync

About dependency management:

  • Dependencies are defined in pyproject.toml under [dependency-groups]

  • uv.lock is the lockfile (similar to what poetry.lock was)

  • After modifying dependencies in pyproject.toml, run uv lock to update the lockfile

  • Run uv sync to install dependencies from the lockfile

  • All development tools (including Nox) are managed by uv

You can now run an interactive Python session or use development tools:

$ uv run python
$ uv run nox

How to test the project

Run the full test suite:

$ uv run nox

List the available Nox sessions:

$ uv run nox --list-sessions

You can also run a specific Nox session. For example, invoke the unit test suite like this:

$ uv run nox --session=tests

Unit tests are located in the test directory, and are written using the pytest testing framework.

How to submit changes

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The Nox test suite must pass without errors and warnings.

  • Include unit tests. This project maintains 100% code coverage.

  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:

$ uv run nox --session=pre-commit -- install

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.

Troubleshootings

If you get errors about _sqlite3 module not found:

    import datetime
    import time
    import collections.abc

>   from _sqlite3 import *
E   ModuleNotFoundError: No module named '_sqlite3

You may follow this StackOverflow solution to fix it by install sqlite3-dev in your os first, then run uv python install <version> again.