| Name | litestar-offline-docs JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Offline API docs for Litestar |
| upload_time | 2024-07-06 19:34:28 |
| maintainer | None |
| docs_url | None |
| author | community-of-python |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# litestar-offline-docs
This package enables "offline mode" for FastAPI (in other words lets you avoid loading assets from CDN).
# Installation
```sh
poetry add litestar-offline-docs
```
# Usage
Just construct static file handler and add it to Litestar application during initialization:
```python
import litestar
from litestar_offline_docs import generate_static_files_config
app = litestar.Litestar(
static_files_config=[generate_static_files_config()],
...
)
```
That's it. Now, the assets for API docs are served locally, not from CDN.
See also: [fastapi-offline-docs](https://github.com/community-of-python/fastapi-offline-docs).
Raw data
{
"_id": null,
"home_page": null,
"name": "litestar-offline-docs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "community-of-python",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9f/89/b101dd2e19d6aa9422b45bacac5950ba4949a8e4e6d097b02ff37f874672/litestar_offline_docs-1.0.1.tar.gz",
"platform": null,
"description": "# litestar-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 litestar-offline-docs\n```\n\n# Usage\n\nJust construct static file handler and add it to Litestar application during initialization:\n\n```python\nimport litestar\n\nfrom litestar_offline_docs import generate_static_files_config\n\napp = litestar.Litestar(\n static_files_config=[generate_static_files_config()],\n ...\n)\n```\n\nThat's it. Now, the assets for API docs are served locally, not from CDN.\n\nSee also: [fastapi-offline-docs](https://github.com/community-of-python/fastapi-offline-docs).\n",
"bugtrack_url": null,
"license": null,
"summary": "Offline API docs for Litestar",
"version": "1.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8258f8e4ca71c563911ca38226b1f49c3a4fcb3b9f8660d98b7295ad34013330",
"md5": "33aa97ad090c3136e461dfdc04e05036",
"sha256": "414a36c02ea7f310c26523718be4b5ade5c43585a9cdba439faf298711ac1574"
},
"downloads": -1,
"filename": "litestar_offline_docs-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33aa97ad090c3136e461dfdc04e05036",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 1055476,
"upload_time": "2024-07-06T19:34:26",
"upload_time_iso_8601": "2024-07-06T19:34:26.720719Z",
"url": "https://files.pythonhosted.org/packages/82/58/f8e4ca71c563911ca38226b1f49c3a4fcb3b9f8660d98b7295ad34013330/litestar_offline_docs-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f89b101dd2e19d6aa9422b45bacac5950ba4949a8e4e6d097b02ff37f874672",
"md5": "d200865c0e7be726f7db34b69eabb1d9",
"sha256": "5746543765e426eaf646f2d86f4f0b359bc08cff6359e7fac9424b12a354d38f"
},
"downloads": -1,
"filename": "litestar_offline_docs-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d200865c0e7be726f7db34b69eabb1d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 1034351,
"upload_time": "2024-07-06T19:34:28",
"upload_time_iso_8601": "2024-07-06T19:34:28.778778Z",
"url": "https://files.pythonhosted.org/packages/9f/89/b101dd2e19d6aa9422b45bacac5950ba4949a8e4e6d097b02ff37f874672/litestar_offline_docs-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 19:34:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "litestar-offline-docs"
}
