Skip to main content

360° health check for Django projects — URLs, templates, views auth, forms (blank + POST smoke + orphan cleaned_data), admin, models, security, migrations, DRF serializers, unsafe auto-gen parsing, save(update_fields=...) consistency + HTML reporter + --diff mode — one command

Project description

django-test-doctor

PyPI version Checks Tests Python Django License: MIT Docs

360° health check for Django projects. One command, fourteen layers of analysis, one verdict. Catches crashes your unit tests miss because they never exercise the blank-init / GET / POST / signal-save / {% url %} / permission-guard / auto-gen-parse / update_fields-consistency pathway an actual user hits first.

Installed as django-test-doctor, imported as django_doctor:

pip install django-test-doctor
./manage.py doctor

Why

./manage.py check validates runtime configuration. djlint validates template syntax. pytest validates whatever you remembered to test. Nothing validates the whole project at once. Doctor does.

Real-world bugs doctor caught in the past week:

  • A form whose __init__ assigns to self.fields['fonction'].choices crashed with AttributeError on every GET because Contact.fonction is a plain CharField — 500 in production. Fixed by the forms check.
  • A post_save signal on Mandat created a ConfigurationTVA without passing the NOT-NULL regime FK — IntegrityError on every mandat creation. Fixed by the post_smoke check.
  • An OperationTVAForm.clean() that assigned cleaned_data["montant_ttc"] while montant_ttc wasn't in Meta.fields — Django silently dropped the value, NOT NULL violation at save. Fixed by the forms_meta check.

Every one of these passed ./manage.py check, passed its unit test suite, and still reached production.

Layers

Layer What it does Status
system Wraps Django's built-in check framework ✅ 0.1
urls Crawls urlpatterns, probes every URL as anon / user / staff / superuser ✅ 0.1
forms Instantiates every Form / ModelForm blank + with empty data ✅ 0.1
migrations Byte-for-byte parity with makemigrations --check --dry-run ✅ 0.1
admin list_display / list_filter / search_fields / ordering exist on the model ✅ 0.2
models __str__ defined, Meta.ordering, no SET_NULL on NOT NULL FK ✅ 0.2
security check --deploy + weak SECRET_KEY + DEBUG=True + empty ALLOWED_HOSTS ✅ 0.2
drf Serializer init + Meta.fieldsMeta.model coherence ✅ 0.3
post_smoke POST every CreateView / UpdateView with auto fixture, fail on 5xx ✅ 0.4
forms_meta cleaned_data[x] = … where x is NOT NULL but not in Meta.fields ✅ 0.5
templates Broken {% url %} / {% static %} / template syntax in first-party templates ✅ 0.6
views First-party view with no LoginRequired / @login_required / DRF permission ✅ 0.6
autogen int(x.split('-')[-1]) auto-gen in Model.save() without try/except ✅ 0.7
update_fields obj.save(update_fields=[...]) dropping fields that save() recomputes ✅ 0.8
i18n Untranslated msgid, stale .mo vs .po, missing _() wrapping 🚧 0.9

Plus in 0.6: --html <path> (standalone HTML report suitable for CI artifacts), --diff <ref> (only show findings on files changed since a git ref — perfect for PR-scoped gating), and a URL-kwargs fixture generator that unlocks the urls and post_smoke checks on detail and edit routes (<int:pk>, <uuid:id>, <slug:slug>).

Quickstart

pip install django-test-doctor

Add to INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    "django_doctor",
]

Then:

./manage.py doctor                              # full report
./manage.py doctor --section forms,post_smoke   # target specific layers
./manage.py doctor --quick                      # skip slow layers
./manage.py doctor --ci                         # exit 1 on critical/error
./manage.py doctor --json                       # machine-readable output

Safety

post_smoke writes to the database (creates a transient superuser, submits forms) but always rolls back via transaction.atomic() + savepoint_rollback. Still, point it at a dev or CI database — never production.

Configuration

In your project's pyproject.toml:

[tool.django-doctor]
enabled = ["*"]
disabled = []                          # or ["post_smoke"] to skip slow layers
fail_on = ["critical", "error"]        # what --ci should bail on
ignore = ["urls:admin:*", "forms:legacy_migrations.*"]

[tool.django-doctor.urls]
roles = ["anonymous", "authenticated", "staff", "superuser"]
skip  = ["admin:*", "djdt:*", "rp-initiated-logout"]
timeout = 10

[tool.django-doctor.forms]
scenarios = ["blank", "empty_data"]

[tool.django-doctor.migrations]
skip_apps = []
include_third_party = false

[tool.django-doctor.post_smoke]
skip = ["legacy:*"]

[tool.django-doctor.security]
forbidden_secret_keys = ["django-insecure", "changeme", "secret"]

Plugin API

Third-party checks plug in via the django_doctor.checks entry point:

[project.entry-points."django_doctor.checks"]
my_check = "my_package.checks:MyCheck"
# my_package/checks.py
# Distribution is django-test-doctor, import path is django_doctor.
from django_doctor import Check, Finding, Severity

class MyCheck(Check):
    id = "my_check"
    description = "Verify my custom invariant"

    def run(self, project):
        for thing in project.iter_something():
            if not thing.ok:
                yield Finding(
                    severity=Severity.ERROR,
                    location=thing.file_path,
                    message=f"{thing!r} is broken",
                    fix_hint="Run ./manage.py fix_things",
                )

Need auto-generated form fixtures in your own tests? The helper doctor uses internally is public:

from django_doctor.fixtures import make_form_fixture

data = make_form_fixture(MyModelForm)
client.post("/my-view/", data)

Status

Alpha — 0.8 ships fourteen layers + HTML reporter + --diff mode + URL-kwargs fixtures. Roadmap in CHANGELOG.md. Battle-tested against a production Django 6 / DRF / PostGIS / pgvector codebase with ~175 models, ~150 forms, 202 serializers, and 300+ URLs.

License

MIT © Paul Guindo

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

django_test_doctor-0.8.0.tar.gz (81.0 kB view details)

Uploaded Source

Built Distribution

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

django_test_doctor-0.8.0-py3-none-any.whl (58.8 kB view details)

Uploaded Python 3

File details

Details for the file django_test_doctor-0.8.0.tar.gz.

File metadata

  • Download URL: django_test_doctor-0.8.0.tar.gz
  • Upload date:
  • Size: 81.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for django_test_doctor-0.8.0.tar.gz
Algorithm Hash digest
SHA256 606f214e2e5b2b8381c982da9f5feaf6274bee25b10da57e76ec4dd709706cdc
MD5 c94e22b75e34c92685ffcf43363fccc6
BLAKE2b-256 a63f7e4b061f81282dcb7f806688e59cd9000cba43312975a04c4573575a247e

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_test_doctor-0.8.0.tar.gz:

Publisher: workflow.yml on Altius-Academy-SNC/django-test-doctor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_test_doctor-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_test_doctor-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41c4b0dbe72030e30d390ee28611bf12d5061b59db31326b0ccd55e0e2e52c91
MD5 643d9a034e4dd9439c5269ec721bb467
BLAKE2b-256 2536d9a3238965a713719bddc742e2a9bf2be86560664772248a46813b939c3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_test_doctor-0.8.0-py3-none-any.whl:

Publisher: workflow.yml on Altius-Academy-SNC/django-test-doctor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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