A tool to generate flowcharts for Django projects
Project description
Django Flow Viz Toolkit
A Django management command that generates flowcharts for your Django project, including models, URLs, middleware, and signals.
You can find this package on PyPI.
Features
- Generates project-wide or app-wise flowcharts.
- Visualizes Django models, URLs, middleware, and signals.
- Uses PyGraphviz to render flowcharts.
Installation
-
We will use pygraphviz to generate the flowcharts. Install it via pip:
pip install pygraphviz
If you face any issues, you might need to install Graphviz on your system first. For example, on Ubuntu, you can run:
sudo apt-get install graphviz
-
Install the package using pip:
pip install django-flow-viz-toolkit
Configuration
After installation, include django-flow-viz-toolkit
in the INSTALLED_APPS
in your Django project's settings.py
:
INSTALLED_APPS = [
...
'flowchart_visualizer',
...
]
Usage
Run the management command to generate the flowchart:
python manage.py generate_flowchart
To generate app-wise flowcharts:
python manage.py generate_flowchart --app-wise
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.
Source Distribution
Built Distribution
File details
Details for the file django-flow-viz-toolkit-0.1.1.tar.gz
.
File metadata
- Download URL: django-flow-viz-toolkit-0.1.1.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84a3eaf6b300a9984bbeaa5785d9b55d9059da02c7cfbef1d48a143d487776a0 |
|
MD5 | 6672581a8a92877134a41cbc0c95fc9b |
|
BLAKE2b-256 | 40afda98f9062d5c2b86b4991f9ed3d9d79c7ec4eaa49eb2fd5ef523abfea172 |
File details
Details for the file django_flow_viz_toolkit-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: django_flow_viz_toolkit-0.1.1-py3-none-any.whl
- Upload date:
- Size: 6.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 156041085a6eb5964e603983e793e4dcb3710d5c5cc4bf5f3ef6357c1a5145eb |
|
MD5 | 29389f3f847fe44fbd97a43e9dc342c3 |
|
BLAKE2b-256 | e7898a1c03245d9b9a158941ac0d99b16f80d1f1da68da367c54256cec560739 |