Install & Compatibility
Where this runs
tested against v2026.3.4 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.222s · 66.6MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 2.8s · import 0.199s · 67MB
66MB installed
● package 66MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
checks
✓ from dockerflow import checks
✗ from dockerflow.checks import *
Import the module, not individual check functions; use register_check instead.
Django
✓ from dockerflow.django import DockerflowMiddleware, dockerflow_view
✗ from dockerflow import DjangoDockerflow
The Django integration uses a specific middleware and view; no class named DjangoDockerflow.
FastAPI
✓ from dockerflow.fastapi import router
✗ from dockerflow import FastAPIRouter
FastAPI integration provides a router object, not a class.
Flask
✓ from dockerflow.flask import Dockerflow
Used as an extension: Dockerflow(app). No common wrong import known.
Minimal Flask app with dockerflow endpoints (__version__, __heartbeat__, __lbheartbeat__) and a custom check.
from dockerflow import checks
from dockerflow.flask import Dockerflow
from flask import Flask
app = Flask(__name__)
dockerflow = Dockerflow(app)
@checks.register('storage')
def storage_check(config):
if not some_storage_available():
return [checks.Error('storage unavailable')]
return []
@app.route('/')
def index():
return 'OK'
if __name__ == '__main__':
app.run()
Errors
Common errors & fixes
ImportError: cannot import name 'DjangoDockerflow' from 'dockerflow'
Old documentation or code snippets refer to a non-existent class.
fixUse `from dockerflow.django import DockerflowMiddleware, dockerflow_view` instead.
AttributeError: module 'dockerflow' has no attribute 'checks'
Importing the top-level package without importing the submodule.
fixExplicitly import `from dockerflow import checks`.
RuntimeError: Unable to find a DockerflowView: No view named 'dockerflow'
Django project missing the dockerflow view URL configuration.
fixAdd URL pattern: `path('__version__', dockerflow_view, name='dockerflow-version')` and ensure middleware is added. fastapi.exceptions.FastAPIError: Invalid args for response status code
Using FastAPI router with a prefix like '/dockerflow' which conflicts with the pre-defined endpoint paths.
fixInclude router with `prefix=''` or no prefix: `app.include_router(router)`.
Upgrade
Version history
2026.3.4latest on PyPI · released Mar 4, 2026
Audit
Dependencies
No dependency data recorded yet.