A Django app to generate PlantUML diagram of project models.
Project description
django-model2puml app is a generator of project models structure in PlantUML class notation.
Quick start
Add “uml_generator” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ... 'puml_generator', ... ]
Run django management command generate_puml like this ./manage.py generate_puml
Params:
--file - output file --title - provide a title for diagram --title-font-size - provide a custom title font size (default is 72) --add-help - add models docstrings to diagram --add-choices - add Choices description of fields to diagram --split-choices - split Choices into per-model classes --add-legend - include explanation of the symbols used --add-omitted-headers - add a header stub for omitted foreign app --omit-history - omit Historical* tables from django-simple-history --omit - specify apps to be omitted in diagram --include - specify apps to be included in diagram; other will be omitted --headers-only - use only model header and relations, omit fields list --url - generate URL to plantuml.com/plantuml/svg/YOUR_DIAGRAM
Check generated PlantUML file!
./manage.py generate_puml --file diagram.puml --include auth contenttypes --add-help --add-legend
Release notes
v0.5.0 (2024-06-16)
Add split-choices flag to split choices into per-model classes
v0.4.1 (2023-02-13)
Fix usage of empty title not to break output filename
v0.4.0 (2023-02-11)
Add title-font-size param
v0.3.0 (2023-02-11)
Add URL to plantuml.com generation
v0.2.1 (2022-06-05)
Refine README.rst
v0.2.0 (2022-04-17)
Add omit-history flag for omit django-simple-history library models
v0.1.14 (2021-03-15)
Fix ImportError in utils.py
v0.1.13 (2020-10-17)
Add documentation to generator
Limit docstrings length
Fix choices generation issues
v0.1.12 (2020-10-15)
Use UTF-8 for saving output
v0.1.11 (2020-10-15)
Add headers-only flag to use only model header and relations, omit fields list in UML
Releases earlier than v0.1.11 yanked due to significant settings issues and must not be used
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.