erdify 0.7.0__tar.gz → 0.7.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {erdify-0.7.0 → erdify-0.7.2}/PKG-INFO +15 -14
- {erdify-0.7.0 → erdify-0.7.2}/README.md +13 -12
- {erdify-0.7.0 → erdify-0.7.2}/pyproject.toml +3 -2
- {erdify-0.7.0 → erdify-0.7.2}/LICENSE +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/__init__.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/__main__.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/cli.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/config.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/generator.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/parser.py +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/py.typed +0 -0
- {erdify-0.7.0 → erdify-0.7.2}/src/erdify/pyproject.py +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: erdify
|
|
3
|
-
Version: 0.7.
|
|
4
|
-
Summary:
|
|
3
|
+
Version: 0.7.2
|
|
4
|
+
Summary: A zero-dependency ERD generator for your Python models — pure AST, no database required.
|
|
5
5
|
Keywords: sqlmodel,sqlalchemy,django,pydantic,dataclass,erd,plantuml,diagram,database,erdify
|
|
6
6
|
Author: devsuit GmbH, Fabian Clemenz
|
|
7
7
|
Author-email: devsuit GmbH <tech@devsuit.de>, Fabian Clemenz <fabian.clemenz@devsuit.de>
|
|
@@ -66,7 +66,7 @@ uvx erdify ./src/database -o erd.puml
|
|
|
66
66
|
erdify ./src/models --title "My Database Schema"
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
See the [documentation](https://
|
|
69
|
+
See the [documentation](https://erdify.devsuit.io/) for installation options, the full CLI, the Python API and more.
|
|
70
70
|
|
|
71
71
|
## 🧬 One Schema, Five Frameworks
|
|
72
72
|
|
|
@@ -77,7 +77,7 @@ syntax differs. Each one produces the **identical** diagram:
|
|
|
77
77
|
|
|
78
78
|
> ℹ️ The SQLModel, SQLAlchemy and Django versions declare keys explicitly (Django
|
|
79
79
|
> via its implicit `id` and `ForeignKey`). Pydantic and dataclasses have no key
|
|
80
|
-
> concept, so they are rendered with [`--infer-keys`](https://
|
|
80
|
+
> concept, so they are rendered with [`--infer-keys`](https://erdify.devsuit.io/usage/filtering/)
|
|
81
81
|
> (`id` → PK, `<x>_id` → FK) to match. The runnable sources live in
|
|
82
82
|
> [`docs/examples/`](https://github.com/devsuit-berlin/erdify/tree/main/docs/examples).
|
|
83
83
|
|
|
@@ -231,18 +231,18 @@ class Order(models.Model):
|
|
|
231
231
|
> or a Django `class Meta: abstract = True` base) are not drawn as tables, but
|
|
232
232
|
> their columns are inherited into concrete entities.
|
|
233
233
|
|
|
234
|
-
For a worked example with the generated PlantUML, see the [Frameworks Overview](https://
|
|
234
|
+
For a worked example with the generated PlantUML, see the [Frameworks Overview](https://erdify.devsuit.io/frameworks/); for Django specifics see [Django ORM](https://erdify.devsuit.io/frameworks/django/).
|
|
235
235
|
|
|
236
236
|
## 📚 Documentation
|
|
237
237
|
|
|
238
|
-
- [Installation](https://
|
|
239
|
-
- [CLI & Python API](https://
|
|
240
|
-
- [Output Formats](https://
|
|
241
|
-
- [Filtering & Key Inference](https://
|
|
242
|
-
- [Viewing the Diagram](https://
|
|
243
|
-
- [CI/CD & pre-commit](https://
|
|
244
|
-
- [Frameworks Overview](https://
|
|
245
|
-
- [Django ORM](https://
|
|
238
|
+
- [Installation](https://erdify.devsuit.io/installation/) — pip, uv, pipx, or run with uvx
|
|
239
|
+
- [CLI & Python API](https://erdify.devsuit.io/usage/cli/) — all CLI options, running as a module, and the Python API
|
|
240
|
+
- [Output Formats](https://erdify.devsuit.io/usage/output-formats/) — PlantUML & Mermaid, `--format`, output naming
|
|
241
|
+
- [Filtering & Key Inference](https://erdify.devsuit.io/usage/filtering/) — `--exclude`, `--exclude-paths`, `--sources`, `--infer-keys`
|
|
242
|
+
- [Viewing the Diagram](https://erdify.devsuit.io/usage/viewing/) — render online, locally with PlantUML, or in VS Code
|
|
243
|
+
- [CI/CD & pre-commit](https://erdify.devsuit.io/usage/ci/) — automate ERD generation in CI and on commit
|
|
244
|
+
- [Frameworks Overview](https://erdify.devsuit.io/frameworks/) — a worked example with the generated PlantUML output
|
|
245
|
+
- [Django ORM](https://erdify.devsuit.io/frameworks/django/) — Django-specific parsing details
|
|
246
246
|
|
|
247
247
|
## 📋 Supported Features
|
|
248
248
|
|
|
@@ -304,6 +304,7 @@ erdify stands on the shoulders of great open-source projects:
|
|
|
304
304
|
|
|
305
305
|
- [PlantUML](https://plantuml.com/) - For the diagram rendering
|
|
306
306
|
- [Graphviz](https://graphviz.org/) - Layout engine behind PlantUML's ER diagrams
|
|
307
|
+
- [Mermaid](https://mermaid.js.org/) - Renders the `--format mermaid` / `html` output
|
|
307
308
|
|
|
308
309
|
**Tooling & infrastructure**
|
|
309
310
|
|
|
@@ -321,4 +322,4 @@ erdify stands on the shoulders of great open-source projects:
|
|
|
321
322
|
|
|
322
323
|
---
|
|
323
324
|
|
|
324
|
-
|
|
325
|
+
Created & maintained with ❤️ by [devsuit GmbH](https://devsuit.de)
|
|
@@ -42,7 +42,7 @@ uvx erdify ./src/database -o erd.puml
|
|
|
42
42
|
erdify ./src/models --title "My Database Schema"
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
See the [documentation](https://
|
|
45
|
+
See the [documentation](https://erdify.devsuit.io/) for installation options, the full CLI, the Python API and more.
|
|
46
46
|
|
|
47
47
|
## 🧬 One Schema, Five Frameworks
|
|
48
48
|
|
|
@@ -53,7 +53,7 @@ syntax differs. Each one produces the **identical** diagram:
|
|
|
53
53
|
|
|
54
54
|
> ℹ️ The SQLModel, SQLAlchemy and Django versions declare keys explicitly (Django
|
|
55
55
|
> via its implicit `id` and `ForeignKey`). Pydantic and dataclasses have no key
|
|
56
|
-
> concept, so they are rendered with [`--infer-keys`](https://
|
|
56
|
+
> concept, so they are rendered with [`--infer-keys`](https://erdify.devsuit.io/usage/filtering/)
|
|
57
57
|
> (`id` → PK, `<x>_id` → FK) to match. The runnable sources live in
|
|
58
58
|
> [`docs/examples/`](https://github.com/devsuit-berlin/erdify/tree/main/docs/examples).
|
|
59
59
|
|
|
@@ -207,18 +207,18 @@ class Order(models.Model):
|
|
|
207
207
|
> or a Django `class Meta: abstract = True` base) are not drawn as tables, but
|
|
208
208
|
> their columns are inherited into concrete entities.
|
|
209
209
|
|
|
210
|
-
For a worked example with the generated PlantUML, see the [Frameworks Overview](https://
|
|
210
|
+
For a worked example with the generated PlantUML, see the [Frameworks Overview](https://erdify.devsuit.io/frameworks/); for Django specifics see [Django ORM](https://erdify.devsuit.io/frameworks/django/).
|
|
211
211
|
|
|
212
212
|
## 📚 Documentation
|
|
213
213
|
|
|
214
|
-
- [Installation](https://
|
|
215
|
-
- [CLI & Python API](https://
|
|
216
|
-
- [Output Formats](https://
|
|
217
|
-
- [Filtering & Key Inference](https://
|
|
218
|
-
- [Viewing the Diagram](https://
|
|
219
|
-
- [CI/CD & pre-commit](https://
|
|
220
|
-
- [Frameworks Overview](https://
|
|
221
|
-
- [Django ORM](https://
|
|
214
|
+
- [Installation](https://erdify.devsuit.io/installation/) — pip, uv, pipx, or run with uvx
|
|
215
|
+
- [CLI & Python API](https://erdify.devsuit.io/usage/cli/) — all CLI options, running as a module, and the Python API
|
|
216
|
+
- [Output Formats](https://erdify.devsuit.io/usage/output-formats/) — PlantUML & Mermaid, `--format`, output naming
|
|
217
|
+
- [Filtering & Key Inference](https://erdify.devsuit.io/usage/filtering/) — `--exclude`, `--exclude-paths`, `--sources`, `--infer-keys`
|
|
218
|
+
- [Viewing the Diagram](https://erdify.devsuit.io/usage/viewing/) — render online, locally with PlantUML, or in VS Code
|
|
219
|
+
- [CI/CD & pre-commit](https://erdify.devsuit.io/usage/ci/) — automate ERD generation in CI and on commit
|
|
220
|
+
- [Frameworks Overview](https://erdify.devsuit.io/frameworks/) — a worked example with the generated PlantUML output
|
|
221
|
+
- [Django ORM](https://erdify.devsuit.io/frameworks/django/) — Django-specific parsing details
|
|
222
222
|
|
|
223
223
|
## 📋 Supported Features
|
|
224
224
|
|
|
@@ -280,6 +280,7 @@ erdify stands on the shoulders of great open-source projects:
|
|
|
280
280
|
|
|
281
281
|
- [PlantUML](https://plantuml.com/) - For the diagram rendering
|
|
282
282
|
- [Graphviz](https://graphviz.org/) - Layout engine behind PlantUML's ER diagrams
|
|
283
|
+
- [Mermaid](https://mermaid.js.org/) - Renders the `--format mermaid` / `html` output
|
|
283
284
|
|
|
284
285
|
**Tooling & infrastructure**
|
|
285
286
|
|
|
@@ -297,4 +298,4 @@ erdify stands on the shoulders of great open-source projects:
|
|
|
297
298
|
|
|
298
299
|
---
|
|
299
300
|
|
|
300
|
-
|
|
301
|
+
Created & maintained with ❤️ by [devsuit GmbH](https://devsuit.de)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "erdify"
|
|
3
|
-
version = "0.7.
|
|
4
|
-
description = "
|
|
3
|
+
version = "0.7.2"
|
|
4
|
+
description = "A zero-dependency ERD generator for your Python models — pure AST, no database required."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = "MIT"
|
|
7
7
|
license-files = ["LICENSE"]
|
|
@@ -37,6 +37,7 @@ dependencies = [] # No runtime dependencies - uses stdlib ast module
|
|
|
37
37
|
|
|
38
38
|
[dependency-groups]
|
|
39
39
|
dev = ["pytest", "pytest-cov", "ruff", "mypy", "sqlmodel", "sqlalchemy", "pydantic", "django"]
|
|
40
|
+
docs = ["mkdocs-material"]
|
|
40
41
|
|
|
41
42
|
[project.scripts]
|
|
42
43
|
erdify = "erdify.cli:main"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|