Skip to main content

dynamic-config-py-web

Native web-framework integrations for dynamic-config-py: the wiring, the request scope, the health surface and the test doors — already written.

The Book · The engine · The Python binding


pip install "dynamic-config-py[fastapi]"      # or [litestar] [flask] [quart]
pip install "dynamic-config-py[django]"       # …[drf] and [ninja] for its API layers
pip install "dynamic-config-py[robyn]"        # Experimental
pip install "dynamic-config-py[django-bolt]"  # Experimental, Python 3.12+
from fastapi import Depends, FastAPI
from dynamic_config import DynamicConfig
from dynamic_config_web.fastapi import config_dependency, setup

config = DynamicConfig(Database, key="db").file("config.toml").env("APP_")
app = FastAPI()

setup(app, config)
database = config_dependency(config)


@app.get("/")
def index(db: Database = Depends(database)):
    return {"host": db.host, "pool": db.pool_size}

That is the whole integration. setup loads before the first request, watches while serving and stops on the way out; /healthz, /readyz and /metrics are mounted; and every handler reads the configuration the request began with.

What it does that a dependency function does not

One reading per request, enforced. The engine's own book states the rule — read current() once per request and use that value for the whole request — because a reload landing mid-request would otherwise show one request two configurations. Here it is a contextvars scope opened by the adapter: a second read is the same object, and a read outside a request raises instead of quietly answering with whatever is installed at that instant.

One watcher, however many times the app is built. A second watch() on one configuration is AlreadyExists. uvicorn --reload rebuilds the app on every edit and a test suite builds one per client, so the watcher is leased and counted: the first holder starts it and the last one stops it.

A watcher in every worker. A watcher is a thread, and a thread does not survive fork() — but the engine's registration does, so a gunicorn --preload worker would be refused a new one while nothing was watching. Every lease re-arms itself in the child.

Liveness and readiness as different questions. /healthz never fails on configuration: a process that cannot reload should stop receiving traffic, not be restarted into reading the same broken file. /readyz is where nothing installed, reloads failing and too stale answer 503.

Diagnostics only when you say so. /_config/explain and /_config/check are not mounted at all without a guard — not mounted-and-403, which would tell a scanner they exist.

The seven

Framework Extra Seam Tier
FastAPI [fastapi] lifespan, Depends, APIRouter, ASGI middleware Beta
Litestar [litestar] InitPlugin.on_app_init — lifespan, Provide, routes, middleware Beta
Flask [flask] extension in app.extensions, Blueprint, before_request Beta
Quart [quart] the async twin, on while_serving Beta
Django [django] AppConfig.ready(), middleware, urls, a management command Beta
Django REST Framework [drf] APIView + a permission class Beta
django-ninja [ninja] a Router, and the operation auth= Beta
Robyn [robyn] startup/shutdown events, @scoped handlers Experimental
django-bolt [django-bolt] BoltAPI(lifespan=…, middleware=…), Router Experimental

Each has a page or a section in the book and a runnable example in examples/; all nine answer the same twelve conformance cases, and where one cannot — Robyn's request scope — the suite says so by name rather than skipping quietly.

What this package is not

It is not a second configuration API. Every value still comes from dynamic-config-py, every diagnostic is the engine's, and the adapters add no cache, no copy and no second source of truth — db.current() is still the read path, and current() here is that read taken once per request.

License

MIT.

Download files

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

Source Distribution

dynamic_config_py_web-0.1.0.tar.gz (139.7 kB view details)

Uploaded Source

Built Distribution

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

dynamic_config_py_web-0.1.0-py3-none-any.whl (70.1 kB view details)

Uploaded Python 3

File details

Details for the file dynamic_config_py_web-0.1.0.tar.gz.

File metadata

  • Download URL: dynamic_config_py_web-0.1.0.tar.gz
  • Upload date:
  • Size: 139.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for dynamic_config_py_web-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1c92060cad3a40af4087102c246d8b3d6150d7aaa041f7fa218c8bfdfe66ae5a
MD5 6ecaeaa64fa543ebb1d332f2e719e6a8
BLAKE2b-256 9fef4092d36329bc5678a4e4790f2f13060dd3ca8b92dbbd63e3f87f878f338f

See more details on using hashes here.

File details

Details for the file dynamic_config_py_web-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dynamic_config_py_web-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8db96ecc05ca8885cf6cb0219434b043ce183c6558e4bc34250d17376a14738c
MD5 c08c689d103683843bd7004ca4452c55
BLAKE2b-256 535865574ad9fcd85d44431ea02bfa9ae059d8064c8ea2812bc672111697eb93

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 Sentry Error logging StatusPage Status page