erdify 0.13.0 — pre-commit hooks, and an empty ERD is now an error

[FabianClemenz]

erdify 0.13.0 is out 🎉

Two things worth your attention: erdify now ships its own pre-commit hooks, and an empty result is an error instead of a silent success.

⚠️ Breaking: no tables found now exits 1

Up to 0.12.3, a run that found no tables warned, wrote a structurally valid but empty diagram, and exited 0. In a CI job that commits the regenerated ERD, that silently replaced a good diagram with an empty one — and a rename or a moved package was enough to trigger it, because --include defaults to models.py.

erdify now exits 1 before generating anything, so the file already on disk is left untouched. The message also tells you why:

Error: No tables found in ./app
  Scanned 2 .py/.sql file(s); 0 matched --include 'models.py'.
  --include defaults to 'models.py'. If your models live in a differently named file, name it, e.g. --include schema.py.
  https://erdify.devsuit.io/troubleshooting/

If an empty schema is legitimate for your project — everything filtered by --exclude, a --sources filter that matches nothing, a schema mid-migration — opt out:

erdify ./src/database -o docs/erd.puml --allow-empty

[tool.erdify]
allow_empty = true

Pre-commit hooks

You no longer need erdify installed in your own environment first:

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/devsuit-berlin/erdify
    rev: v0.13.0
    hooks:
      - id: erdify
        args: [./src/database, -o, docs/erd.puml]

Two ids: erdify regenerates the diagram, and erdify-check never writes and fails when the committed diagram has drifted. --check is part of the latter's entry point, so overriding args can't drop it.

New documentation

• Comparison — erdify next to eralchemy, sqlalchemy-schemadisplay, erdantic, django-extensions graph_models and DBML, including where each of those is the better choice.
• Python Parsing Limitations — what the AST parser genuinely cannot see: runtime-built models, __table_args__, composite foreign keys, foreign keys hidden in sa_column.
• Troubleshooting — symptom-first fixes.

The docs site also gained social cards, edit links, footer navigation and a changelog page, and the PyPI project page finally links to the docs instead of the README anchor.

---

📦 Release · 📖 Docs · 📝 Changelog