fastapi-standalone-docs 0.0.1__tar.gz

fastapi_standalone_docs-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 IOXIO®
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_standalone_docs-0.0.1/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: fastapi-standalone-docs
+Version: 0.0.1
+Summary: Host FastAPI Swagger UI and ReDoc without third party CDNs
+License: MIT
+Author: IOXIO Ltd
+Requires-Python: >=3.8.1,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: scripts
+Requires-Dist: fastapi (>=0.95.2,<0.98.0)
+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)
+[![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: BSD 3-Clause](https://img.shields.io/pypi/l/fastapi-standalone-docs)](https://opensource.org/license/mit/)
+
+Host FastAPI Swagger UI and ReDoc without any third party CDNs. Handy if you want to be
+able to use the docs offline or want to avoid loading content from 3rd party CDNs due to
+privacy reasons.
+
+This library was heavily inspired by
+[fastapi-offline-swagger-ui](https://github.com/ahmetoner/fastapi-offline-swagger-ui),
+but we wanted a way to take it into use with less boilerplate code and also have it
+hosted on PyPI.
+
+## Installation
+
+The package is available on PyPI:
+
+```bash
+pip install fastapi-standalone-docs
+```
+
+## Usage
+
+Import `StandaloneDocs` and pass in the FastAPI application to it:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(app=app)
+```
+
+The static files will by default be served from subpaths of the `docs_url` and
+`redoc_url` as you've specified in your FastAPI app. The library doesn't make any
+assumption on any particular path being reserved for the library. And if you disable
+either of the two UIs, the corresponding files won't either be served unnecessarily.
+
+This example would move the Swagger UI and the static files needed for it to the path
+`/swagger` and disable the ReDoc interface and the static files needed by it:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI(docs_url="/swagger", redoc_url=None)
+StandaloneDocs(app=app)
+```
+
+By default, the library will use the FastAPI favicons, and they're served from
+`{docs_url}/fastapi/favicon.png` and `{redoc_url}/fastapi/favicon.png`. You can use your
+own favicons like this, which will also disable the FastAPI icons:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(
+    app=app,
+    redoc_favicon_url="/favicon.png",
+    swagger_favicon_url="/favicon.png",
+)
+```
+
+To make the docs truly stand alone the Google Fonts are by default disabled (they are
+used in the ReDoc interface). If you want to enable them just set
+`with_google_fonts=True`, like this:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(
+    app=app,
+    with_google_fonts=True,
+)
+```
+
+## 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:
+
+```bash
+pre-commit install
+poetry install
+```
+
+Running tests locally:
+
+```bash
+poetry run invoke test
+```
+
+Updating the static files from the CDNs:
+
+```bash
+poetry 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
+```
+
+## 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).
+

fastapi_standalone_docs-0.0.1/README.md

@@ -0,0 +1,126 @@
+# 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)
+[![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: BSD 3-Clause](https://img.shields.io/pypi/l/fastapi-standalone-docs)](https://opensource.org/license/mit/)
+
+Host FastAPI Swagger UI and ReDoc without any third party CDNs. Handy if you want to be
+able to use the docs offline or want to avoid loading content from 3rd party CDNs due to
+privacy reasons.
+
+This library was heavily inspired by
+[fastapi-offline-swagger-ui](https://github.com/ahmetoner/fastapi-offline-swagger-ui),
+but we wanted a way to take it into use with less boilerplate code and also have it
+hosted on PyPI.
+
+## Installation
+
+The package is available on PyPI:
+
+```bash
+pip install fastapi-standalone-docs
+```
+
+## Usage
+
+Import `StandaloneDocs` and pass in the FastAPI application to it:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(app=app)
+```
+
+The static files will by default be served from subpaths of the `docs_url` and
+`redoc_url` as you've specified in your FastAPI app. The library doesn't make any
+assumption on any particular path being reserved for the library. And if you disable
+either of the two UIs, the corresponding files won't either be served unnecessarily.
+
+This example would move the Swagger UI and the static files needed for it to the path
+`/swagger` and disable the ReDoc interface and the static files needed by it:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI(docs_url="/swagger", redoc_url=None)
+StandaloneDocs(app=app)
+```
+
+By default, the library will use the FastAPI favicons, and they're served from
+`{docs_url}/fastapi/favicon.png` and `{redoc_url}/fastapi/favicon.png`. You can use your
+own favicons like this, which will also disable the FastAPI icons:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(
+    app=app,
+    redoc_favicon_url="/favicon.png",
+    swagger_favicon_url="/favicon.png",
+)
+```
+
+To make the docs truly stand alone the Google Fonts are by default disabled (they are
+used in the ReDoc interface). If you want to enable them just set
+`with_google_fonts=True`, like this:
+
+```python
+from fastapi import FastAPI
+from fastapi_standalone_docs import StandaloneDocs
+
+app = FastAPI()
+StandaloneDocs(
+    app=app,
+    with_google_fonts=True,
+)
+```
+
+## 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:
+
+```bash
+pre-commit install
+poetry install
+```
+
+Running tests locally:
+
+```bash
+poetry run invoke test
+```
+
+Updating the static files from the CDNs:
+
+```bash
+poetry 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
+```
+
+## 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).

fastapi_standalone_docs-0.0.1/fastapi_standalone_docs/__init__.py

@@ -0,0 +1,2 @@
+# flake8: noqa
+from fastapi_standalone_docs.standalone_docs import StandaloneDocs

fastapi_standalone_docs-0.0.1/fastapi_standalone_docs/scripts.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+from typing import List
+from urllib.request import urlretrieve
+
+import fastapi_standalone_docs
+
+FASTAPI_FILES = [
+    "https://fastapi.tiangolo.com/img/favicon.png",
+    "https://raw.githubusercontent.com/tiangolo/fastapi/master/LICENSE",
+]
+
+SWAGGER_FILES = [
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/LICENSE",
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui.css",
+    "https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui-bundle.js",
+]
+
+REDOC_FILES = [
+    "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js.LICENSE.txt",
+    "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js",
+    "https://cdn.redoc.ly/redoc/logo-mini.svg",
+]
+
+
+def update_docs():
+    static_path = Path(fastapi_standalone_docs.__path__[0]) / "static"
+    fastapi_path = static_path / "fastapi"
+    swagger_path = static_path / "swagger"
+    redoc_path = static_path / "redoc"
+
+    fastapi_path.mkdir(parents=True, exist_ok=True)
+    swagger_path.mkdir(parents=True, exist_ok=True)
+    redoc_path.mkdir(parents=True, exist_ok=True)
+
+    download_files(fastapi_path, FASTAPI_FILES)
+    download_files(swagger_path, SWAGGER_FILES)
+    download_files(redoc_path, REDOC_FILES)
+
+    patch_redoc_logo(target=static_path / "redoc")
+
+
+def download_files(destination: Path, urls: List[str]) -> None:
+    for url in urls:
+        filename = url.split("/")[-1]
+        urlretrieve(url, destination / filename)
+
+
+def patch_redoc_logo(target: Path):
+    file = target / "redoc.standalone.js"
+    content = file.read_text(encoding="utf-8")
+    content = content.replace(
+        '"https://cdn.redoc.ly/redoc/logo-mini.svg"',
+        'window.location.pathname+"/logo-mini.svg"',
+    )
+    file.write_text(content, encoding="utf-8")
+
+
+if __name__ == "__main__":
+    update_docs()

fastapi_standalone_docs-0.0.1/fastapi_standalone_docs/standalone_docs.py

@@ -0,0 +1,74 @@
+from pathlib import Path
+from typing import Optional
+
+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: Optional[str] = None,
+        redoc_favicon_url: Optional[str] = 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 patch_swagger(self, swagger_favicon_url: Optional[str]):
+        if self.app.docs_url:
+            if not swagger_favicon_url:
+                swagger_favicon_url = self.app.docs_url + "/fastapi/favicon.png"
+                self.app.mount(
+                    self.app.docs_url + "/fastapi/",
+                    StaticFiles(directory=self.static_path / "fastapi"),
+                )
+
+            self.app.mount(
+                self.app.docs_url + "/",
+                StaticFiles(directory=self.static_path / "swagger"),
+            )
+
+            def patched_get_swagger_ui_html(*args, **kwargs):
+                return get_swagger_ui_html(
+                    *args,
+                    **kwargs,
+                    swagger_favicon_url=swagger_favicon_url,
+                    swagger_css_url=self.app.docs_url + "/swagger-ui.css",
+                    swagger_js_url=self.app.docs_url + "/swagger-ui-bundle.js",
+                )
+
+            applications.get_swagger_ui_html = patched_get_swagger_ui_html
+
+    def patch_redoc(self, redoc_favicon_url: Optional[str]):
+        if self.app.redoc_url:
+            if not redoc_favicon_url:
+                redoc_favicon_url = self.app.redoc_url + "/fastapi/favicon.png"
+                self.app.mount(
+                    self.app.redoc_url + "/fastapi/",
+                    StaticFiles(directory=self.static_path / "fastapi"),
+                )
+
+            self.app.mount(
+                self.app.redoc_url + "/",
+                StaticFiles(directory=self.static_path / "redoc"),
+            )
+
+            def patched_get_redoc_html(*args, **kwargs):
+                return get_redoc_html(
+                    *args,
+                    **kwargs,
+                    redoc_js_url=self.app.redoc_url + "/redoc.standalone.js",
+                    redoc_favicon_url=redoc_favicon_url,
+                    with_google_fonts=self.with_google_fonts,
+                )
+
+            applications.get_redoc_html = patched_get_redoc_html

fastapi_standalone_docs-0.0.1/fastapi_standalone_docs/static/fastapi/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastián Ramírez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

fastapi_standalone_docs-0.0.1/fastapi_standalone_docs/static/redoc/logo-mini.svg

@@ -0,0 +1 @@
+<svg width="300" height="300" xmlns="http://www.w3.org/2000/svg"><path fill="#0044d4" d="M249.488 231.49a123.68 123.68 0 0 0-22.86-12.66 111.55 111.55 0 0 0-42.12-214.75h-171.8a8.18 8.18 0 0 0-5.78 14 7.48 7.48 0 0 0 5.78 2.48 95 95 0 1 1 0 190c-.83 0-1.38.27-2.21.27a8 8 0 0 0-6.33 7.71v1.11a7.69 7.69 0 0 0 7.71 7.7h5.52a92.93 92.93 0 0 1 50.66 17.62 95.33 95.33 0 0 1 34.14 45.43 8.27 8.27 0 0 0 7.7 5.52h171.8a7.76 7.76 0 0 0 6.61-3.58 8 8 0 0 0 1.09-7.42 109.06 109.06 0 0 0-39.91-53.43zm-158-37.16a111.62 111.62 0 0 0 32.76-78.75 110 110 0 0 0-32.76-78.74 105.91 105.91 0 0 0-20.37-16.24h113.39a95 95 0 1 1 0 190 3.55 3.55 0 0 0-1.65.27H70.798a109.06 109.06 0 0 0 20.65-16.54h.04zm-13.77 37.16c-1.92-1.37-4.13-2.75-6.33-4.13h117.8a94.79 94.79 0 0 1 80.12 52h-153.63a112 112 0 0 0-38-47.87h.04z" class="cls-1"/><path fill="#0044d4" d="M158.398 115.58a8.11 8.11 0 0 0 8.26 8.26h82.6a8.26 8.26 0 0 0 0-16.52h-82.6a8.29 8.29 0 0 0-8.26 8.26zM152.298 156.92h82.59a8.26 8.26 0 0 0 0-16.52h-82.59a8.11 8.11 0 0 0-8.26 8.26 8.28 8.28 0 0 0 8.26 8.26zM152.298 90.8h82.59a8.26 8.26 0 0 0 0-16.52h-82.59a8.11 8.11 0 0 0-8.26 8.26 8.46 8.46 0 0 0 8.26 8.26z" class="cls-1"/></svg>