fastapi-standalone-docs 0.0.1__py3-none-any.whl

fastapi_standalone_docs-0.0.1.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,19 @@
+fastapi_standalone_docs/__init__.py,sha256=Z8btRrND2S1O7eHP-7pyJ6y6jkUonp-xS3A4evJpg00,82
+fastapi_standalone_docs/scripts.py,sha256=foJW0kJqTz5EN_oCirL-arUEdGXxVTNLHvrmEAbqTrw,1826
+fastapi_standalone_docs/standalone_docs.py,sha256=tR_iLeqJ2BuumiQwmdd_0NmrYxkhni6pRxdYXHHSWeA,2709
+fastapi_standalone_docs/static/fastapi/LICENSE,sha256=Tsif_IFIW5f-xYSy1KlhAy7v_oNEU4lP2cEnSQbMdE4,1086
+fastapi_standalone_docs/static/fastapi/favicon.png,sha256=cOPeoFIQCjIrPOstAVMGlDq6ODvn1adAuwVgqsV83vM,412
+fastapi_standalone_docs/static/redoc/logo-mini.svg,sha256=C9tZQb-HUmZr80BoH8Aw5syJA3ctVvoVvC4EoVtsDTg,1174
+fastapi_standalone_docs/static/redoc/redoc.standalone.js,sha256=DppGqyVg7YR8QBILUYLEqIA3OR0JECDYGtV35U7p3Hg,1042007
+fastapi_standalone_docs/static/redoc/redoc.standalone.js.LICENSE.txt,sha256=m-O2qTO1Rl1Tuv777q8S4VUiX1ZNYrXnEjJQqFiJ3B0,2634
+fastapi_standalone_docs/static/swagger/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+fastapi_standalone_docs/static/swagger/swagger-ui-bundle.js,sha256=rC3gtSIhxpalJh4cLClpkHR4Veukz_vw8mWLg2bXDmE,1048219
+fastapi_standalone_docs/static/swagger/swagger-ui.css,sha256=SAA66tKLwuKJA6buaPtWkbgU4beu9n-GYPUplCMeAzE,145206
+fastapi_standalone_docs/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_standalone_docs/tests/conftests.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_standalone_docs/tests/test_standalone_docs.py,sha256=BN9c5NQVC0ADtgZEan_fsLBkvJnkhsF2ASjH0mlLeUc,5787
+fastapi_standalone_docs-0.0.1.dist-info/LICENSE,sha256=a9Hb3Z53CCDmNiiz0eliyKDg5o63LIuEdGLQ3EmHy-I,1064
+fastapi_standalone_docs-0.0.1.dist-info/METADATA,sha256=aI6lf1EuA4j6Bm35nc9wfqRqJFBG2Tr_3HXtEq2lSt0,4774
+fastapi_standalone_docs-0.0.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+fastapi_standalone_docs-0.0.1.dist-info/entry_points.txt,sha256=mh1ZwM5qQ_PsUYsbFvxFGoY1t33wwmklAh8bD08jnzI,94
+fastapi_standalone_docs-0.0.1.dist-info/RECORD,,

fastapi_standalone_docs-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.6.1
+Root-Is-Purelib: true
+Tag: py3-none-any

fastapi_standalone_docs-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+update-fastapi-standalone-docs=fastapi_standalone_docs.scripts:update_docs
+