fastapi-standalone-docs 0.2.0__tar.gz → 0.3.0__tar.gz

{fastapi_standalone_docs-0.2.0 → fastapi_standalone_docs-0.3.0}/PKG-INFO

@@ -1,27 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fastapi-standalone-docs
-Version: 0.2.0
+Version: 0.3.0
 Summary: Host FastAPI Swagger UI and ReDoc without third party CDNs
-Home-page: https://github.com/ioxiocom/fastapi-standalone-docs
-License: MIT
+Keywords: fastapi,swagger,swagger-ui,redoc,openapi,offline
 Author: IOXIO Ltd
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Provides-Extra: scripts
-Requires-Dist: fastapi (>=0.109.1,<1)
-Project-URL: Repository, https://github.com/ioxiocom/fastapi-standalone-docs
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Documentation
+Requires-Dist: fastapi>=0.133.0,<1
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/ioxiocom/fastapi-standalone-docs
+Project-URL: Issues, https://github.com/ioxiocom/fastapi-standalone-docs/issues
 Description-Content-Type: text/markdown
 
 # FastAPI Standalone Docs
 
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ioxiocom/fastapi-standalone-docs/publish.yaml)](https://github.com/ioxiocom/fastapi-standalone-docs/actions/workflows/publish.yaml)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPI](https://img.shields.io/pypi/v/fastapi-standalone-docs)](https://pypi.org/project/fastapi-standalone-docs/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-standalone-docs)](https://pypi.org/project/fastapi-standalone-docs/)
 [![License: MIT](https://img.shields.io/pypi/l/fastapi-standalone-docs)](https://opensource.org/license/mit/)
@@ -105,51 +110,53 @@ StandaloneDocs(
 ### Disclaimer
 
 **Note!** If you create multiple FastAPI apps in the same runtime (quite unlikely
-use-case), using StandaloneDocs on one of them will affect the other ones as well, as
-the library patches two of the shared functions (`get_swagger_ui_html` and
-`get_redoc_html`). Thus the library should not be used in a such setup unless all the
-apps will use StandaloneDocs with the same settings.
+use-case), for example by mounting one app inside another, using StandaloneDocs on one
+of them will affect the other ones as well, as the library patches two of the shared
+functions (`get_swagger_ui_html` and `get_redoc_html`). Thus, the library should not be
+used in such a setup unless all the apps will use StandaloneDocs with the same settings
+and the same `docs_url`, `redoc_url` and `openapi_url` on the FastAPI app itself. If any
+of those differ, only the app that called StandaloneDocs last will serve its docs
+correctly.
 
 ## Development
 
 PRs are welcome!
 
-This project is using [Poetry](https://python-poetry.org/) and
-[pre-commit](https://pre-commit.com/), so please ensure you've installed both. To set up
-the project with them run:
+This project is using [uv](https://docs.astral.sh/uv/), so please ensure you've
+[installed it](https://docs.astral.sh/uv/getting-started/installation/). To set up the
+project run:
 
 ```bash
-pre-commit install
-poetry install
+uv sync
+uv run pre-commit install
 ```
 
-Running tests locally:
+Running tests locally (pre-commit hooks, mypy, pytest and a dependency audit):
 
 ```bash
-poetry run invoke test
+uv run invoke test
 ```
 
 Updating the static files from the CDNs:
 
 ```bash
-poetry run update-fastapi-standalone-docs
+uv run update-fastapi-standalone-docs
 ```
 
 If you want to test using it locally in some other project, in that project run this
 (make sure to adjust the path to the local repo):
 
 ```bash
-poetry add ../fastapi-standalone-docs --editable
+uv add --editable ../fastapi-standalone-docs
 ```
 
 ## License
 
 The code of this library itself is released under the [MIT license](./LICENSE). Please
 however note that this library also contains parts of
-[ReDoc](./fastapi_standalone_docs/static/redoc/), which is licensed under the
-[MIT license](./fastapi_standalone_docs/static/redoc/redoc.standalone.js.LICENSE.txt),
-[Swagger UI](./fastapi_standalone_docs/static/swagger/), which is licensed under the
-[Apache 2.0 License](./fastapi_standalone_docs/static/swagger/LICENSE), as well as parts
-of [FastAPI](./fastapi_standalone_docs/static/fastapi) (the favicon), which is licensed
-under the [MIT license](./fastapi_standalone_docs/static/fastapi/LICENSE).
-
+[ReDoc](./src/fastapi_standalone_docs/static/redoc/), which is licensed under the
+[MIT license](./src/fastapi_standalone_docs/static/redoc/redoc.standalone.js.LICENSE.txt),
+[Swagger UI](./src/fastapi_standalone_docs/static/swagger/), which is licensed under the
+[Apache 2.0 License](./src/fastapi_standalone_docs/static/swagger/LICENSE), as well as
+parts of [FastAPI](./src/fastapi_standalone_docs/static/fastapi) (the favicon), which is
+licensed under the [MIT license](./src/fastapi_standalone_docs/static/fastapi/LICENSE).

{fastapi_standalone_docs-0.2.0 → fastapi_standalone_docs-0.3.0}/README.md

@@ -1,7 +1,7 @@
 # FastAPI Standalone Docs
 
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ioxiocom/fastapi-standalone-docs/publish.yaml)](https://github.com/ioxiocom/fastapi-standalone-docs/actions/workflows/publish.yaml)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPI](https://img.shields.io/pypi/v/fastapi-standalone-docs)](https://pypi.org/project/fastapi-standalone-docs/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-standalone-docs)](https://pypi.org/project/fastapi-standalone-docs/)
 [![License: MIT](https://img.shields.io/pypi/l/fastapi-standalone-docs)](https://opensource.org/license/mit/)
@@ -85,50 +85,53 @@ StandaloneDocs(
 ### Disclaimer
 
 **Note!** If you create multiple FastAPI apps in the same runtime (quite unlikely
-use-case), using StandaloneDocs on one of them will affect the other ones as well, as
-the library patches two of the shared functions (`get_swagger_ui_html` and
-`get_redoc_html`). Thus the library should not be used in a such setup unless all the
-apps will use StandaloneDocs with the same settings.
+use-case), for example by mounting one app inside another, using StandaloneDocs on one
+of them will affect the other ones as well, as the library patches two of the shared
+functions (`get_swagger_ui_html` and `get_redoc_html`). Thus, the library should not be
+used in such a setup unless all the apps will use StandaloneDocs with the same settings
+and the same `docs_url`, `redoc_url` and `openapi_url` on the FastAPI app itself. If any
+of those differ, only the app that called StandaloneDocs last will serve its docs
+correctly.
 
 ## Development
 
 PRs are welcome!
 
-This project is using [Poetry](https://python-poetry.org/) and
-[pre-commit](https://pre-commit.com/), so please ensure you've installed both. To set up
-the project with them run:
+This project is using [uv](https://docs.astral.sh/uv/), so please ensure you've
+[installed it](https://docs.astral.sh/uv/getting-started/installation/). To set up the
+project run:
 
 ```bash
-pre-commit install
-poetry install
+uv sync
+uv run pre-commit install
 ```
 
-Running tests locally:
+Running tests locally (pre-commit hooks, mypy, pytest and a dependency audit):
 
 ```bash
-poetry run invoke test
+uv run invoke test
 ```
 
 Updating the static files from the CDNs:
 
 ```bash
-poetry run update-fastapi-standalone-docs
+uv run update-fastapi-standalone-docs
 ```
 
 If you want to test using it locally in some other project, in that project run this
 (make sure to adjust the path to the local repo):
 
 ```bash
-poetry add ../fastapi-standalone-docs --editable
+uv add --editable ../fastapi-standalone-docs
 ```
 
 ## License
 
 The code of this library itself is released under the [MIT license](./LICENSE). Please
 however note that this library also contains parts of
-[ReDoc](./fastapi_standalone_docs/static/redoc/), which is licensed under the
-[MIT license](./fastapi_standalone_docs/static/redoc/redoc.standalone.js.LICENSE.txt),
-[Swagger UI](./fastapi_standalone_docs/static/swagger/), which is licensed under the
-[Apache 2.0 License](./fastapi_standalone_docs/static/swagger/LICENSE), as well as parts
-of [FastAPI](./fastapi_standalone_docs/static/fastapi) (the favicon), which is licensed
-under the [MIT license](./fastapi_standalone_docs/static/fastapi/LICENSE).
+[ReDoc](./src/fastapi_standalone_docs/static/redoc/), which is licensed under the
+[MIT license](./src/fastapi_standalone_docs/static/redoc/redoc.standalone.js.LICENSE.txt),
+[Swagger UI](./src/fastapi_standalone_docs/static/swagger/), which is licensed under the
+[Apache 2.0 License](./src/fastapi_standalone_docs/static/swagger/LICENSE), as well as
+parts of [FastAPI](./src/fastapi_standalone_docs/static/fastapi) (the favicon), which is
+licensed under the [MIT license](./src/fastapi_standalone_docs/static/fastapi/LICENSE).

fastapi_standalone_docs-0.3.0/pyproject.toml

@@ -0,0 +1,88 @@
+[project]
+name = "fastapi-standalone-docs"
+version = "0.3.0"
+description = "Host FastAPI Swagger UI and ReDoc without third party CDNs"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = ["fastapi>=0.133.0,<1"]
+keywords = [
+    "fastapi",
+    "swagger",
+    "swagger-ui",
+    "redoc",
+    "openapi",
+    "offline",
+]
+classifiers = [
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Topic :: Documentation",
+]
+
+[[project.authors]]
+name = "IOXIO Ltd"
+
+[project.urls]
+Homepage = "https://github.com/ioxiocom/fastapi-standalone-docs"
+Issues = "https://github.com/ioxiocom/fastapi-standalone-docs/issues"
+
+[project.scripts]
+update-fastapi-standalone-docs = "fastapi_standalone_docs.scripts:update_docs"
+
+[build-system]
+requires = ["uv_build>=0.13,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv]
+required-version = ">=0.13"
+
+[tool.uv.build-backend]
+source-include = ["tests/**"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-v"]
+filterwarnings = ["ignore::DeprecationWarning"]
+
+[tool.mypy]
+files = [
+    "src",
+    "tests",
+]
+warn_return_any = true
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+    "RUF",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+    "mypy>=2.4.0",
+    "httpx2>=2.13.1",
+    "invoke>=3.0.3",
+    "pre-commit>=4.6.2",
+    "ruff==0.17.0",
+]

fastapi_standalone_docs-0.3.0/pyproject.toml.orig

@@ -0,0 +1,69 @@
+[project]
+name = "fastapi-standalone-docs"
+version = "0.3.0"
+description = "Host FastAPI Swagger UI and ReDoc without third party CDNs"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "IOXIO Ltd" }]
+requires-python = ">=3.11"
+dependencies = ["fastapi>=0.133.0,<1"]
+keywords = ["fastapi", "swagger", "swagger-ui", "redoc", "openapi", "offline"]
+classifiers = [
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Topic :: Documentation",
+]
+
+[project.urls]
+Homepage = "https://github.com/ioxiocom/fastapi-standalone-docs"
+Issues = "https://github.com/ioxiocom/fastapi-standalone-docs/issues"
+
+[project.scripts]
+update-fastapi-standalone-docs = "fastapi_standalone_docs.scripts:update_docs"
+
+[build-system]
+requires = ["uv_build>=0.13,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+source-include = ["tests/**"]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+    "mypy>=2.4.0",
+    "httpx2>=2.13.1",
+    "invoke>=3.0.3",
+    "pre-commit>=4.6.2",
+    "ruff==0.17.0",  # keep in sync with the ruff-pre-commit rev
+]
+
+[tool.uv]
+required-version = ">=0.13"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-v"]
+filterwarnings = ["ignore::DeprecationWarning"]
+
+[tool.mypy]
+files = ["src", "tests"]
+warn_return_any = true
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+# E/W: pycodestyle; F: Pyflakes; I: isort; UP: pyupgrade; B: flake8-bugbear;
+# SIM: flake8-simplify; RUF: Ruff-specific rules
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]

{fastapi_standalone_docs-0.2.0 → fastapi_standalone_docs-0.3.0/src}/fastapi_standalone_docs/__init__.py

@@ -1,2 +1,3 @@
-# flake8: noqa
 from fastapi_standalone_docs.standalone_docs import StandaloneDocs
+
+__all__ = ["StandaloneDocs"]

{fastapi_standalone_docs-0.2.0 → fastapi_standalone_docs-0.3.0/src}/fastapi_standalone_docs/scripts.py

@@ -1,5 +1,4 @@
 from pathlib import Path
-from typing import List
 from urllib.request import urlretrieve
 
 import fastapi_standalone_docs
@@ -10,14 +9,14 @@ FASTAPI_FILES = [
 ]
 
 SWAGGER_FILES = [
-    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.19.0/LICENSE",
-    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.19.0/swagger-ui.css",
-    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.19.0/swagger-ui-bundle.js",
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1/LICENSE",
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1/swagger-ui.css",
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1/swagger-ui-bundle.js",
 ]
 
 REDOC_FILES = [
-    "https://cdn.jsdelivr.net/npm/redoc@2.4.0/bundles/redoc.standalone.js.LICENSE.txt",
-    "https://cdn.jsdelivr.net/npm/redoc@2.4.0/bundles/redoc.standalone.js",
+    "https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js.LICENSE.txt",
+    "https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js",
     "https://cdn.redoc.ly/redoc/logo-mini.svg",
 ]
 
@@ -39,7 +38,7 @@ def update_docs():
     patch_redoc_logo(target=static_path / "redoc")
 
 
-def download_files(destination: Path, urls: List[str]) -> None:
+def download_files(destination: Path, urls: list[str]) -> None:
     for url in urls:
         filename = url.split("/")[-1]
         urlretrieve(url, destination / filename)

fastapi_standalone_docs-0.3.0/src/fastapi_standalone_docs/standalone_docs.py

@@ -0,0 +1,109 @@
+from pathlib import Path
+
+from fastapi import FastAPI, applications
+from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
+from fastapi.staticfiles import StaticFiles
+
+import fastapi_standalone_docs
+
+
+class StandaloneDocs:
+    def __init__(
+        self,
+        app: FastAPI,
+        with_google_fonts: bool = False,
+        swagger_favicon_url: str | None = None,
+        redoc_favicon_url: str | None = None,
+    ):
+        self.app = app
+        self.with_google_fonts = with_google_fonts
+        self.static_path = Path(fastapi_standalone_docs.__path__[0]) / "static"
+
+        self.patch_swagger(swagger_favicon_url)
+        self.patch_redoc(redoc_favicon_url)
+
+    def get_root_path(self, openapi_url: str) -> str:
+        """
+        Extract from the openapi_url the root_path the app is served from in this
+        request, such as "/myapp1", or "" when it has none.
+
+        An app mounted in another app does not have access to its own prefix: mount()
+        doesn't touch app.root_path, the prefix arrives with each request in the ASGI
+        scope, and a proxy may even set a different one per request. The functions we
+        are patching don't get access to the full request, only the arguments FastAPI
+        passes them.
+
+        However FastAPI passes these functions an openapi_url parameter, which it builds
+        from the root_path of the request and the openapi_url of the app, making the
+        latter a suffix of it. Removing that suffix gives the root_path of the request.
+
+            "/myapp1/openapi.json" - "/openapi.json" -> "/myapp1"
+            "/openapi.json"        - "/openapi.json" -> ""
+
+        An openapi_url that doesn't end in the app's own falls back to "", which is
+        correct for an app served from the root and the best guess otherwise.
+        """
+        suffix = self.app.openapi_url or ""
+        if suffix and openapi_url.endswith(suffix):
+            return openapi_url.removesuffix(suffix)
+        return ""
+
+    def patch_swagger(self, swagger_favicon_url: str | None):
+        if self.app.openapi_url and self.app.docs_url:
+            docs_url = self.app.docs_url
+
+            if not swagger_favicon_url:
+                self.app.mount(
+                    docs_url + "/fastapi/",
+                    StaticFiles(directory=self.static_path / "fastapi"),
+                )
+
+            self.app.mount(
+                docs_url + "/",
+                StaticFiles(directory=self.static_path / "swagger"),
+            )
+
+            def patched_get_swagger_ui_html(*args, **kwargs):
+                root_path = self.get_root_path(kwargs.get("openapi_url", ""))
+                return get_swagger_ui_html(
+                    *args,
+                    **kwargs,
+                    swagger_favicon_url=(
+                        swagger_favicon_url
+                        or f"{root_path}{docs_url}/fastapi/favicon.png"
+                    ),
+                    swagger_css_url=f"{root_path}{docs_url}/swagger-ui.css",
+                    swagger_js_url=f"{root_path}{docs_url}/swagger-ui-bundle.js",
+                )
+
+            applications.get_swagger_ui_html = patched_get_swagger_ui_html
+
+    def patch_redoc(self, redoc_favicon_url: str | None):
+        if self.app.openapi_url and self.app.redoc_url:
+            redoc_url = self.app.redoc_url
+
+            if not redoc_favicon_url:
+                self.app.mount(
+                    redoc_url + "/fastapi/",
+                    StaticFiles(directory=self.static_path / "fastapi"),
+                )
+
+            self.app.mount(
+                redoc_url + "/",
+                StaticFiles(directory=self.static_path / "redoc"),
+            )
+
+            def patched_get_redoc_html(*args, **kwargs):
+                root_path = self.get_root_path(kwargs.get("openapi_url", ""))
+                return get_redoc_html(
+                    *args,
+                    **kwargs,
+                    redoc_js_url=f"{root_path}{redoc_url}/redoc.standalone.js",
+                    redoc_favicon_url=(
+                        redoc_favicon_url
+                        or f"{root_path}{redoc_url}/fastapi/favicon.png"
+                    ),
+                    with_google_fonts=self.with_google_fonts,
+                )
+
+            applications.get_redoc_html = patched_get_redoc_html

fastapi_standalone_docs-0.3.0/src/fastapi_standalone_docs/static/redoc/logo-mini.svg

@@ -0,0 +1,4 @@
+<svg width="300" height="300" viewBox="0 0 300 300" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M245.054 94.8809C245.054 138.62 209.581 174.078 165.823 174.078H36.3477V166.351C75.8367 166.351 107.849 134.353 107.849 94.8809C107.849 55.4088 75.8367 23.4104 36.3477 23.4104V15.6838H165.823C209.581 15.6838 245.054 51.1416 245.054 94.8809Z" fill="#2467F2"/>
+<path d="M245.054 282.249C245.054 238.51 209.581 203.052 165.823 203.052H36.3477V210.779C75.8367 210.779 107.849 242.777 107.849 282.249H245.054Z" fill="#2467F2"/>
+</svg>