Skip to main content

Offline API docs for Litestar

Project description

litestar-offline-docs

This package enables "offline mode" for FastAPI (in other words lets you avoid loading assets from CDN).

Installation

poetry add litestar-offline-docs

Usage

Just construct static file handler and add it to Litestar application during initialization:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

litestar_offline_docs-1.1.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

litestar_offline_docs-1.1.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file litestar_offline_docs-1.1.0.tar.gz.

File metadata

File hashes

Hashes for litestar_offline_docs-1.1.0.tar.gz
Algorithm Hash digest
SHA256 0f6548f4495fdd28ea2668fbb11cfd77ddb9281e857be2281fea8d0cce1c252c
MD5 b104fe8d63f761bf0bc52ee2490d890e
BLAKE2b-256 4d935550d477280127fe80f1b9375ba2ee10a9cdddd9124e2c5e3c83db0deaac

See more details on using hashes here.

File details

Details for the file litestar_offline_docs-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for litestar_offline_docs-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18715b5993b25cf50f02bcdd7ea3050e3ce39fadc2364e98d0038809a6cbdba4
MD5 51656eb14513a2509e502c786a9b3a2e
BLAKE2b-256 af7c58991841e7302161f4c34b3341496cbad5caaafe75f3d431a2d13e9c774f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page