https://github.com/gothenburgbitfactory/taskchampion-py
Python interface to Taskchampion
https://github.com/gothenburgbitfactory/taskchampion-py
Last synced: 11 months ago
JSON representation
Python interface to Taskchampion
- Host: GitHub
- URL: https://github.com/gothenburgbitfactory/taskchampion-py
- Owner: GothenburgBitFactory
- License: mit
- Created: 2024-09-02T19:23:14.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-02T00:22:05.000Z (over 1 year ago)
- Last Synced: 2025-08-29T16:57:05.744Z (11 months ago)
- Language: Python
- Size: 146 KB
- Stars: 5
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Python Taskchampion Bindings
This package contains Python bindings for [TaskChampion](https://github.com/GothenburgBitFactory/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
```py
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](https://github.com/GothenburgBitFactory/taskchampion-py/issues/6)
for more information.
## Development
This project is built using [maturin](https://github.com/PyO3/maturin).
To install:
```shell
pipx install maturin
```
To build wheels:
```shell
maturin build
```
This stores wheels in the `target/wheels` folder by default.
### Testing
Extra testing dependencies are installed via `poetry`:
```shell
poetry install
```
To run tests:
```shell
poetry shell
maturin develop
pytest
```
or
```shell
poetry run maturin develop
poetry run pytest
```