Name | fastapi-offline-docs JSON |
Version |
1.1.0
JSON |
| download |
home_page | None |
Summary | Offline API docs for FastAPI |
upload_time | 2025-02-01 06:45:15 |
maintainer | None |
docs_url | None |
author | community-of-python |
requires_python | <4,>=3.9 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# fastapi-offline-docs
This package enables "offline mode" for FastAPI (in other words lets you avoid loading assets from CDN).
# Installation
```sh
poetry add fastapi-offline-docs
```
# Usage
Before:
```python
import fastapi
app = fastapi.FastAPI(docs_url="path/to/doc", redoc_url="path/to/redoc")
```
After:
```python
import fastapi
from fastapi_offline_docs import enable_offline_docs
app = fastapi.FastAPI(docs_url="path/to/doc", redoc_url="path/to/redoc")
enable_offline_docs(app)
```
Now, the assets for API docs are served locally, not from CDN.
See also: [litestar-offline-docs](https://github.com/community-of-python/litestar-offline-docs).
Raw data
{
"_id": null,
"home_page": null,
"name": "fastapi-offline-docs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "community-of-python",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/eb/b3/8ccaea776ccb5ab4a887876fbfccf72efa08a4277c0cb9021f31942f818e/fastapi_offline_docs-1.1.0.tar.gz",
"platform": null,
"description": "# fastapi-offline-docs\n\nThis package enables \"offline mode\" for FastAPI (in other words lets you avoid loading assets from CDN).\n\n# Installation\n\n```sh\npoetry add fastapi-offline-docs\n```\n\n# Usage\n\nBefore:\n\n```python\nimport fastapi\n\napp = fastapi.FastAPI(docs_url=\"path/to/doc\", redoc_url=\"path/to/redoc\")\n```\n\nAfter:\n\n```python\nimport fastapi\nfrom fastapi_offline_docs import enable_offline_docs\n\napp = fastapi.FastAPI(docs_url=\"path/to/doc\", redoc_url=\"path/to/redoc\")\nenable_offline_docs(app)\n```\n\nNow, the assets for API docs are served locally, not from CDN.\n\nSee also: [litestar-offline-docs](https://github.com/community-of-python/litestar-offline-docs).\n",
"bugtrack_url": null,
"license": null,
"summary": "Offline API docs for FastAPI",
"version": "1.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "52482a47c05bc1e8ba145472ca52d9a0e59c975cbe59cfabead74c66be106a4f",
"md5": "b4b754c623385ad038b390b99ee8cd8e",
"sha256": "fee49e387b46b365e8bb70212b57306676517225b6c0ef9f92d63914f167e607"
},
"downloads": -1,
"filename": "fastapi_offline_docs-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4b754c623385ad038b390b99ee8cd8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 751222,
"upload_time": "2025-02-01T06:45:12",
"upload_time_iso_8601": "2025-02-01T06:45:12.709741Z",
"url": "https://files.pythonhosted.org/packages/52/48/2a47c05bc1e8ba145472ca52d9a0e59c975cbe59cfabead74c66be106a4f/fastapi_offline_docs-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ebb38ccaea776ccb5ab4a887876fbfccf72efa08a4277c0cb9021f31942f818e",
"md5": "89323667c82d6bf3a81ed8cbb3e95bba",
"sha256": "3c6453a2480bada0d3eb165ab396b265ba92ee6650110807293d7d34ccb816df"
},
"downloads": -1,
"filename": "fastapi_offline_docs-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "89323667c82d6bf3a81ed8cbb3e95bba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 748700,
"upload_time": "2025-02-01T06:45:15",
"upload_time_iso_8601": "2025-02-01T06:45:15.013494Z",
"url": "https://files.pythonhosted.org/packages/eb/b3/8ccaea776ccb5ab4a887876fbfccf72efa08a4277c0cb9021f31942f818e/fastapi_offline_docs-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 06:45:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fastapi-offline-docs"
}