Skip to main content

A tool to generate flowcharts for Django projects

Project description

Django Flow Viz Toolkit

Flowchart Example

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

  1. 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
    
  2. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-flow-viz-toolkit-0.1.1.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

django_flow_viz_toolkit-0.1.1-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page