Skip to content

The agent that turns websites into APIs!

release: v0.2.7 - implement single source of truth for versioning

kalil03216349e2e8a813
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 46dba38..c55d4b1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [0.2.7] - 2025-12-27
+
+### Changed
+- **Version management**: Implemented single source of truth for versioning
+ - Version now defined only in `pyproject.toml`
+ - `__init__.py` reads version dynamically using `importlib.metadata`
+ - Eliminates need to manually update version in multiple files
+ - Added `RELEASING.md` with release process documentation
+
## [0.2.6] - 2025-12-27
### Fixed
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..65c67dd
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,49 @@
+# Release Process
+
+This project uses a single source of truth for versioning: `pyproject.toml`.
+
+## How it works
+
+- The version is defined **only** in `pyproject.toml`
+- `src/reverse_api/__init__.py` reads the version dynamically using `importlib.metadata`
+- This means you only need to update the version in **one place**
+
+## To create a new release
+
+1. **Update version in `pyproject.toml`**:
+ ```toml
+ version = "x.y.z"
+ ```
+
+2. **Update CHANGELOG.md** with release notes
+
+3. **Run the clean build script**:
+ ```bash
+ ./scripts/clean_build.sh
+ ```
+
+4. **Commit and tag**:
+ ```bash
+ git add pyproject.toml CHANGELOG.md
+ git commit -m "release: vx.y.z - description"
+ git tag vx.y.z -m "Release vx.y.z: description"
+ ```
+
+5. **Push to GitHub**:
+ ```bash
+ git push origin main
+ git push origin vx.y.z
+ ```
+
+6. **Publish to PyPI**:
+ ```bash
+ source .env # or export UV_PUBLISH_TOKEN manually
+ uv publish
+ ```
+
+## Important Notes
+
+- **Never manually edit** `src/reverse_api/__init__.py` to change the version
+- The version is automatically read from the installed package metadata
+- During development (before install), the version shows as `0.0.0.dev`
+- After installation, it shows the correct version from `pyproject.toml`
diff --git a/pyproject.toml b/pyproject.toml
index a356dd5..188034e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "reverse-api-engineer"
-version = "0.2.6"
+version = "0.2.7"
description = "A tool to capture browser traffic for API reverse engineering"
readme = "README.md"
requires-python = ">=3.11"
diff --git a/src/reverse_api/__init__.py b/src/reverse_api/__init__.py
index 9e7f85f..17c6995 100644
--- a/src/reverse_api/__init__.py
+++ b/src/reverse_api/__init__.py
@@ -1,3 +1,9 @@
"""Reverse API - Browser traffic capture for API reverse engineering."""
-__version__ = "0.2.6"
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+ __version__ = version("reverse-api-engineer")
+except PackageNotFoundError:
+ # Package is not installed, use a fallback version
+ __version__ = "0.0.0.dev"