aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri@ouroboros.rocks>2026-03-07 22:46:56 +0100
committerDimitri Staessens <dimitri@ouroboros.rocks>2026-03-08 14:24:30 +0100
commit7d043001b956fb80116cf8eedcca1d5aaf2edbd4 (patch)
treed2f925b1f3085cabd0256949a454d15075a8dde8 /README.md
parent7a4c37e8b673328dda59cec11ab9dce66c22a312 (diff)
downloadpyouroboros-0.23.0.tar.gz
pyouroboros-0.23.0.zip
build: Use git tags for versioningHEAD0.23.0master
Replace setup.py metadata with pyproject.toml and derive version from git tags with setuptools-scm. Adds git archive support for setuptools-scm version detection.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 96e6151..0d57a5e 100644
--- a/README.md
+++ b/README.md
@@ -388,5 +388,16 @@ unbind_process(pid, "my_name")
Some example code is in the examples folder.
+## Versioning
+
+pyOuroboros uses `setuptools_scm` to derive its version from git tags.
+
+**Compatibility contract across Ouroboros repositories:**
+
+| Scope | Rule |
+|---|---|
+| ouroboros (C) ↔ pyouroboros / rumba | Shared `major.minor` — pyouroboros requires at least the same ouroboros `major.minor` |
+| pyouroboros ↔ rumba ↔ ouroboros-integration | Strict lockstep `major.minor.patch` — always released together |
+
## License
pyOuroboros is LGPLv2.1. The examples are 3-clause BSD.