Python Taskchampion Bindings

This package contains Python bindings for TaskChampion. It follows the TaskChampion API closely, with minimal adaptation for Python.

Versioning

The taskchampion-py package version matches the Rust crate's version. When an additional package release is required for the same Rust crate, a fourth version component is used; for example 1.2.0.1 for the second release of taskchampion-py containing TaskChampion version 1.2.0.

Usage

from taskchampion import Replica

# Set up a replica.
r = Replica.new_on_disk("/some/path", true)

# .. and so on, very similar to the Rust API.

See the API documentation for more information.

Development

This project is built using maturin.

To install:

pipx install maturin

To build wheels:

maturin build

This stores wheels in the target/wheels folder by default.

Testing

Extra testing dependencies are installed via poetry:

poetry install

To run tests:

poetry shell
maturin develop
pytest

or

poetry run maturin develop
poetry run pytest