From 4aae815497eccd0c80d8bec51ccd091ac5e5bf76 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Wed, 25 Dec 2024 15:42:04 -0500 Subject: [PATCH] Update package metadata (#5) - Name the package `taskchampion-py` consistently. - Use the TaskChampion version number. - Track the MSRV of TaskChampion. For the moment, the version is 0.7.0-pre1 so that we can test releasing later. --- Cargo.lock | 4 ++-- Cargo.toml | 7 ++++--- README.md | 8 +++++++- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 2469f63..60a95bd 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1467,8 +1467,8 @@ dependencies = [ ] [[package]] -name = "taskchampion_python" -version = "0.1.0" +name = "taskchampion-py" +version = "0.7.0-pre1" dependencies = [ "anyhow", "chrono", diff --git a/Cargo.toml b/Cargo.toml index e698100..4843bfb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,12 @@ [package] -name = "taskchampion_python" -version = "0.1.0" +name = "taskchampion-py" +version = "0.7.0-pre1" edition = "2021" +# This should match the MSRV of the `taskchampion` crate. +rust-version = "1.78.0" [package.metadata.maturin] name = "taskchampion" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [lib] name = "taskchampion" diff --git a/README.md b/README.md index cc9fd4a..cf09673 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # Python Taskchampion Bindings -This submodule contains bindings to the Taskchampion +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`. ## Development