https://github.com/mr-destructive/django-mermaid

Generate ER Diagram for your Django project in Markdown with Mermaid
https://github.com/mr-destructive/django-mermaid

django mermaid-diagrams python

Last synced: 3 months ago
JSON representation

Generate ER Diagram for your Django project in Markdown with Mermaid

• Host: GitHub
• URL: https://github.com/mr-destructive/django-mermaid
• Owner: Mr-Destructive
• Created: 2022-08-03T15:01:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-09T15:26:09.000Z (about 2 years ago)
• Last Synced: 2023-03-04T19:27:47.817Z (almost 2 years ago)
• Topics: django, mermaid-diagrams, python
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Django Mermaid

Create ER Diagrams (Entity Relationship Diagrams) of your Django projects related to different models of associated applications in Mermaid.

Get a Markdown representation of the relationships in your Django project models with Mermaid.

```

python mermaid.py 

```

TODO:

- Create a python/django package

- Provide various options for saving the diagram

Example: Base Django Project

```mermaid

erDiagram

LogEntry{

AutoField id

DateTimeField action_time

TextField object_id

CharField object_repr

PositiveSmallIntegerField action_flag

TextField change_message

}

Permission{

AutoField id

CharField name

CharField codename

}

Group{

AutoField id

CharField name

}

User{

AutoField id

CharField password

DateTimeField last_login

BooleanField is_superuser

CharField username

CharField first_name

CharField last_name

CharField email

BooleanField is_staff

BooleanField is_active

DateTimeField date_joined

}

ContentType{

AutoField id

CharField app_label

CharField model

}

Session{

CharField session_key

TextField session_data

DateTimeField expire_date

}

LogEntry||--|{User : user

LogEntry||--|{ContentType : content_type

Permission}|--|{Group : group

Permission}|--|{User : user

Permission||--|{ContentType : content_type

Group}|--|{User : user

Group}|--|{Permission : permissions

User||--|{LogEntry : logentry

User}|--|{Group : groups

User}|--|{Permission : user_permissions

ContentType||--|{LogEntry : logentry

ContentType||--|{Permission : permission

```