Changelog¶

All notable changes to this project are documented in the repository CHANGELOG.md.

[0.2.0] - 2026-08-03¶

Mermaid ER diagrams are now parseable: attribute names are no longer quoted (a quoted string is a COMMENT to the parser, so nothing rendered)
Key constraints are comma-separated (PK, FK), names outside ATTRIBUTE_WORD are backtick-escaped, entity names drop the characters the lexer forbids
Cardinalities no longer claim a mandatory child: ||--|| → ||--o|, ||--|{ → ||--o{

--er-style — compat (default), optional (native type? suffix), minimal
Column comments in the Mermaid comment slot; parameterized types keep their precision (VARCHAR(255))

Async library and CLI to introspect SQLAlchemy databases and write Markdown docs with Mermaid ER diagrams
Dialect support for PostgreSQL, MySQL/MariaDB, and SQLite (async drivers via extras)
Table/column comments, detailed indexes, and check constraint SQL in generated docs
Mermaid cardinalities inferred from UNIQUE/PK + FK nullability (1–1, 1–N, N–N via junction tables)
--version, --verbose, dialect-aware --schema default
Tests, mypy (strict), Ruff, and GitHub Actions CI
MIT license and community docs
MkDocs documentation site