fastapi-router-versioning 0.1.1__tar.gz → 0.1.2__tar.gz

{fastapi_router_versioning-0.1.1 → fastapi_router_versioning-0.1.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: fastapi-router-versioning
-Version: 0.1.1
-Summary: Native, router-based API versioning for FastAPI, featuring per-version docs and a declarative route lifecycle.
+Version: 0.1.2
+Summary: Router-based API versioning for FastAPI, with per-version docs and a declarative route lifecycle.
 Project-URL: Homepage, https://github.com/mat81black/fastapi-router-versioning
 Project-URL: Repository, https://github.com/mat81black/fastapi-router-versioning
 Project-URL: Issues, https://github.com/mat81black/fastapi-router-versioning/issues
@@ -26,15 +26,15 @@ Requires-Python: >=3.10
 Requires-Dist: fastapi!=0.137.0,!=0.137.1,>=0.120.0
 Description-Content-Type: text/markdown
 
-# FastAPI Router Versioning (Native API Versioning)
+# FastAPI Router Versioning
 
 [![PyPI](https://img.shields.io/pypi/v/fastapi-router-versioning)](https://pypi.org/project/fastapi-router-versioning/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![Python](https://img.shields.io/pypi/pyversions/fastapi-router-versioning)](https://pypi.org/project/fastapi-router-versioning/)
 
-The native, router-based solution for **API versioning in FastAPI**.
+Router-based API versioning for FastAPI.
 
-If you want to implement **FastAPI API versioning**, you can simply annotate your routes with `@api_version`, call `.versionize()`, and get isolated URL prefixes, per-version Swagger UI, and a full route lifecycle — all without touching your existing application structure.
+FastAPI has no built-in versioning mechanism. The common workaround — duplicating routers or managing prefixes manually — breaks down quickly as the number of versions grows. This package adds declarative versioning directly on routes, with isolated URL prefixes, per-version Swagger UI, and a full route lifecycle, without touching the existing application structure.
 
 ---
 
@@ -93,7 +93,7 @@ RouterVersioner(app=app, routers=router, version_format=VersionFormat.SEMVER).ve
 # Mounts: GET /v1_0/items   GET /v2_0/items
 ```
 
-Each version also gets its own Swagger UI at `/v1_0/docs`, `/v2_0/docs`, and so on.
+Each version gets its own Swagger UI at `/v1_0/docs`, `/v2_0/docs`, and so on.
 
 ---
 
@@ -117,9 +117,9 @@ RouterVersioner(app=app, routers=router, version_format=VersionFormat.CALVER).ve
 # Mounts: GET /2025-01-01/items
 ```
 
-Any string is a valid CalVer token: `"2025-01-01"`, `"v3"`, `"stable"`, etc.
+Valid CalVer tokens: `"2025-01-01"`, `"v3"`, `"stable"`, etc.
 
-> **CalVer sorting:** versions are sorted lexicographically, so strings must be comparable in the intended order. ISO dates (`"2025-01-01"`) and zero-padded numbers (`"v01"`, `"v02"`) work correctly. Strings like `"v1"`, `"v10"`, `"v2"` will **not** sort correctly and will cause routes to appear in the wrong versions.
+**CalVer sorting:** versions are sorted lexicographically, so tokens must be comparable in the intended order. ISO dates (`"2025-01-01"`) and zero-padded numbers (`"v01"`, `"v02"`) work correctly. Non-padded strings like `"v1"`, `"v10"`, `"v2"` will not sort correctly and will cause routes to appear in the wrong versions.
 
 ---
 
@@ -181,8 +181,8 @@ Call `.versionize()` after constructing the object. It returns the list of activ
 
 | Parameter | Type | Required | Description |
 |---|---|---|---|
-| `version` | `tuple[int, int] \| str` | yes | Version when this route is introduced |
-| `deprecate_in` | same \| `None` | no | Version when this route is marked deprecated in the docs |
+| `version` | `tuple[int, int] \| str` | yes | First version in which this route is active |
+| `deprecate_in` | same \| `None` | no | Version in which this route is marked deprecated in the docs |
 | `remove_in` | same \| `None` | no | Version from which this route is removed entirely |
 
 All three parameters must match the `version_format` configured on `RouterVersioner`
@@ -278,7 +278,7 @@ RouterVersioner(
 ).versionize()
 ```
 
-The hook receives `(schema: dict, version: VersionT)` and must return the (modified) dict.
+The hook receives `(schema: dict, version: VersionT)` and must return the modified dict.
 
 ### OpenAPI Callbacks and Webhooks
 
@@ -325,12 +325,11 @@ RouterVersioner(
 # /v2_0/openapi.json → webhooks: /order-created (V2)  ← /payment-failed removed
 ```
 
-The same introduce / `remove_in` lifecycle applies. Webhook versions follow route versions:
-a new webhook version only appears once a route version creates that API prefix.
+The same `remove_in` lifecycle applies. A new webhook version only appears once a route version creates that API prefix.
 
 ### Multiple routers
 
-Pass a list of routers to version routes that are split across modules:
+Pass a list of routers to version routes split across modules:
 
 ```python
 RouterVersioner(
@@ -344,7 +343,7 @@ All routers are versioned together under the same prefix tree.
 
 ### Self-hosted docs (air-gapped environments)
 
-By default, Swagger UI and ReDoc assets are loaded from the FastAPI CDN. In air-gapped or corporate environments, point them at assets you host yourself:
+By default, Swagger UI and ReDoc assets are loaded from the FastAPI CDN. In air-gapped or corporate environments, point them at locally hosted assets:
 
 ```python
 RouterVersioner(
@@ -360,7 +359,7 @@ RouterVersioner(
 ).versionize()
 ```
 
-See [`examples/download_static_assets.py`](examples/download_static_assets.py) for a ready-made script that downloads all required assets in one step, and [`examples/self_hosted_docs_app.py`](examples/self_hosted_docs_app.py) for a complete working example.
+See [`examples/download_static_assets.py`](examples/download_static_assets.py) for a script that downloads all required assets in one step, and [`examples/self_hosted_docs_app.py`](examples/self_hosted_docs_app.py) for a complete working example.
 
 ### Reverse proxy / sub-app mounting
 

{fastapi_router_versioning-0.1.1 → fastapi_router_versioning-0.1.2}/README.md

@@ -1,12 +1,12 @@
-# FastAPI Router Versioning (Native API Versioning)
+# FastAPI Router Versioning
 
 [![PyPI](https://img.shields.io/pypi/v/fastapi-router-versioning)](https://pypi.org/project/fastapi-router-versioning/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![Python](https://img.shields.io/pypi/pyversions/fastapi-router-versioning)](https://pypi.org/project/fastapi-router-versioning/)
 
-The native, router-based solution for **API versioning in FastAPI**.
+Router-based API versioning for FastAPI.
 
-If you want to implement **FastAPI API versioning**, you can simply annotate your routes with `@api_version`, call `.versionize()`, and get isolated URL prefixes, per-version Swagger UI, and a full route lifecycle — all without touching your existing application structure.
+FastAPI has no built-in versioning mechanism. The common workaround — duplicating routers or managing prefixes manually — breaks down quickly as the number of versions grows. This package adds declarative versioning directly on routes, with isolated URL prefixes, per-version Swagger UI, and a full route lifecycle, without touching the existing application structure.
 
 ---
 
@@ -65,7 +65,7 @@ RouterVersioner(app=app, routers=router, version_format=VersionFormat.SEMVER).ve
 # Mounts: GET /v1_0/items   GET /v2_0/items
 ```
 
-Each version also gets its own Swagger UI at `/v1_0/docs`, `/v2_0/docs`, and so on.
+Each version gets its own Swagger UI at `/v1_0/docs`, `/v2_0/docs`, and so on.
 
 ---
 
@@ -89,9 +89,9 @@ RouterVersioner(app=app, routers=router, version_format=VersionFormat.CALVER).ve
 # Mounts: GET /2025-01-01/items
 ```
 
-Any string is a valid CalVer token: `"2025-01-01"`, `"v3"`, `"stable"`, etc.
+Valid CalVer tokens: `"2025-01-01"`, `"v3"`, `"stable"`, etc.
 
-> **CalVer sorting:** versions are sorted lexicographically, so strings must be comparable in the intended order. ISO dates (`"2025-01-01"`) and zero-padded numbers (`"v01"`, `"v02"`) work correctly. Strings like `"v1"`, `"v10"`, `"v2"` will **not** sort correctly and will cause routes to appear in the wrong versions.
+**CalVer sorting:** versions are sorted lexicographically, so tokens must be comparable in the intended order. ISO dates (`"2025-01-01"`) and zero-padded numbers (`"v01"`, `"v02"`) work correctly. Non-padded strings like `"v1"`, `"v10"`, `"v2"` will not sort correctly and will cause routes to appear in the wrong versions.
 
 ---
 
@@ -153,8 +153,8 @@ Call `.versionize()` after constructing the object. It returns the list of activ
 
 | Parameter | Type | Required | Description |
 |---|---|---|---|
-| `version` | `tuple[int, int] \| str` | yes | Version when this route is introduced |
-| `deprecate_in` | same \| `None` | no | Version when this route is marked deprecated in the docs |
+| `version` | `tuple[int, int] \| str` | yes | First version in which this route is active |
+| `deprecate_in` | same \| `None` | no | Version in which this route is marked deprecated in the docs |
 | `remove_in` | same \| `None` | no | Version from which this route is removed entirely |
 
 All three parameters must match the `version_format` configured on `RouterVersioner`
@@ -250,7 +250,7 @@ RouterVersioner(
 ).versionize()
 ```
 
-The hook receives `(schema: dict, version: VersionT)` and must return the (modified) dict.
+The hook receives `(schema: dict, version: VersionT)` and must return the modified dict.
 
 ### OpenAPI Callbacks and Webhooks
 
@@ -297,12 +297,11 @@ RouterVersioner(
 # /v2_0/openapi.json → webhooks: /order-created (V2)  ← /payment-failed removed
 ```
 
-The same introduce / `remove_in` lifecycle applies. Webhook versions follow route versions:
-a new webhook version only appears once a route version creates that API prefix.
+The same `remove_in` lifecycle applies. A new webhook version only appears once a route version creates that API prefix.
 
 ### Multiple routers
 
-Pass a list of routers to version routes that are split across modules:
+Pass a list of routers to version routes split across modules:
 
 ```python
 RouterVersioner(
@@ -316,7 +315,7 @@ All routers are versioned together under the same prefix tree.
 
 ### Self-hosted docs (air-gapped environments)
 
-By default, Swagger UI and ReDoc assets are loaded from the FastAPI CDN. In air-gapped or corporate environments, point them at assets you host yourself:
+By default, Swagger UI and ReDoc assets are loaded from the FastAPI CDN. In air-gapped or corporate environments, point them at locally hosted assets:
 
 ```python
 RouterVersioner(
@@ -332,7 +331,7 @@ RouterVersioner(
 ).versionize()
 ```
 
-See [`examples/download_static_assets.py`](examples/download_static_assets.py) for a ready-made script that downloads all required assets in one step, and [`examples/self_hosted_docs_app.py`](examples/self_hosted_docs_app.py) for a complete working example.
+See [`examples/download_static_assets.py`](examples/download_static_assets.py) for a script that downloads all required assets in one step, and [`examples/self_hosted_docs_app.py`](examples/self_hosted_docs_app.py) for a complete working example.
 
 ### Reverse proxy / sub-app mounting
 

fastapi_router_versioning-0.1.2/RELEASE_NOTES.md

@@ -0,0 +1,47 @@
+# Release Notes
+
+## Latest Changes
+
+## 0.1.2 (2026-06-25)
+
+### Internal
+
+* 👷 Add Python 3.14 classifier to `pyproject.toml` to align with the versions already covered by CI.
+
+### Docs
+
+* 📝 Update README and `pyproject.toml` to clarify package description and improve documentation consistency. PR [#12](https://github.com/mat81black/fastapi-router-versioning/pull/12) by [@mat81black](https://github.com/mat81black).
+
+## 0.1.1 (2026-06-24)
+
+### Features
+
+* ✨ Add per-version OpenAPI schema caching: schemas are generated once and cached, reducing overhead on repeated requests. PR [#5](https://github.com/mat81black/fastapi-router-versioning/pull/5) by [@mat81black](https://github.com/mat81black).
+* ✨ Track which routes belong to each version to invalidate the cache automatically when the route set changes. PR [#5](https://github.com/mat81black/fastapi-router-versioning/pull/5) by [@mat81black](https://github.com/mat81black).
+
+### Fixes
+
+* 🐛 Fix WebSocket routes not being handled correctly in `versioned_routers` when the cache was active. PR [#5](https://github.com/mat81black/fastapi-router-versioning/pull/5) by [@mat81black](https://github.com/mat81black).
+* 🐛 Improve OpenAPI schema cache resilience: cache is now safely bypassed on unexpected errors instead of raising. PR [#5](https://github.com/mat81black/fastapi-router-versioning/pull/5) by [@mat81black](https://github.com/mat81black).
+
+### Internal
+
+* 👷 Add `prepare-release.yml` workflow and `scripts/prepare_release.py` for automated version bumping and release PR creation. PR [#6](https://github.com/mat81black/fastapi-router-versioning/pull/6) by [@mat81black](https://github.com/mat81black).
+* 👷 Add `changes` job to `test.yml` and `test-redistribute.yml` to skip CI when no relevant files are modified. PR [#10](https://github.com/mat81black/fastapi-router-versioning/pull/10) by [@mat81black](https://github.com/mat81black).
+
+## 0.1.0 (2025-06-24)
+
+🚀 First official public release of **fastapi-router-versioning**.
+
+Router-based API versioning for FastAPI, with declarative route lifecycle, per-version OpenAPI schemas, and isolated documentation — without altering the core application structure.
+
+### Features
+
+* ✨ SemVer & CalVer support: route versioning using `(major, minor)` tuples or lexicographically sortable arbitrary strings.
+* ✨ Declarative route lifecycle: introduce, deprecate (`deprecate_in`), and remove (`remove_in`) routes across versions.
+* ✨ Per-version documentation: isolated Swagger UI, ReDoc, and `openapi.json` for each active version.
+* ✨ OpenAPI schema hook: modify the filtered schema per version via `openapi_hook`.
+* ✨ Independent webhook versioning via `webhook_routers`, with propagation of per-route OpenAPI Callbacks.
+* ✨ Latest-version alias: expose the highest active version under a stable configurable prefix.
+* ✨ Self-hosted docs: full control over Swagger/ReDoc static assets and option to disable Google Fonts.
+* ✨ Reverse proxy aware: resolves and injects the ASGI `root_path` at request time.

{fastapi_router_versioning-0.1.1 → fastapi_router_versioning-0.1.2}/fastapi_router_versioning/__init__.py

@@ -1,5 +1,5 @@
 from .versioner import RouterVersioner, VersionFormat, VersionT, api_version
 
-__version__ = "0.1.1"
+__version__ = "0.1.2"
 
 __all__ = ["RouterVersioner", "api_version", "VersionFormat", "VersionT"]

{fastapi_router_versioning-0.1.1 → fastapi_router_versioning-0.1.2}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "fastapi-router-versioning"
 dynamic = ["version"]
-description = "Native, router-based API versioning for FastAPI, featuring per-version docs and a declarative route lifecycle."
+description = "Router-based API versioning for FastAPI, with per-version docs and a declarative route lifecycle."
 readme = "README.md"
 license = "MIT"
 license-files = ["LICENSE"]

fastapi_router_versioning-0.1.1/RELEASE_NOTES.md

@@ -1,37 +0,0 @@
-# Release Notes
-
-## Latest Changes
-
-## 0.1.1 (2026-06-24)
-
-### Features
-
-* ✨ Add per-version OpenAPI schema caching: schemas are generated once and cached, significantly reducing overhead on repeated requests.
-* ✨ Track which routes belong to each version to invalidate the cache automatically when the route set changes.
-
-### Fixes
-
-* 🐛 Fix WebSocket routes not being handled correctly in `versioned_routers` when the cache was active.
-* 🐛 Improve OpenAPI schema cache resilience: cache is now safely bypassed on unexpected errors instead of raising.
-
-### Internal
-
-* 👷 Add `prepare-release.yml` workflow and `scripts/prepare_release.py` for automated version bumping and release PR creation.
-* 👷 Add `changes` job to `test.yml` and `test-redistribute.yml` to skip CI when no relevant files are modified.
-
-## 0.1.0 (2025-06-24)
-
-🚀 First official public release of **fastapi-router-versioning**.
-
-This library provides an elegant, native, router-based solution for **FastAPI API versioning**. It allows you to manage the entire lifecycle of your endpoints declaratively with a single decorator, automatically generating isolated schemas and documentation for every version without altering your core application structure.
-
-### Features
-
-* ✨ SemVer & CalVer support: route versioning using `(major, minor)` tuples or lexicographically sortable arbitrary strings (like ISO dates).
-* ✨ Declarative route lifecycle: introduce, deprecate (`deprecate_in`), and remove (`remove_in`) routes across versions.
-* ✨ Per-version documentation: isolated Swagger UI, ReDoc, and `openapi.json` for each active version.
-* ✨ Advanced OpenAPI customization via `openapi_hook`: manipulate the filtered JSON schema per version (vendor extensions, custom logos, API Gateway integrations).
-* ✨ Independent webhook versioning via `webhook_routers`, with native propagation of per-route OpenAPI Callbacks and WebSockets.
-* ✨ Latest-version alias: expose the highest active version under a stable configurable prefix (e.g. `/latest`).
-* ✨ Enterprise & air-gapped ready: full control over Swagger/ReDoc static assets and option to disable Google Fonts.
-* ✨ Reverse proxy aware: dynamically resolves and injects the ASGI `root_path` at request time.