Skip to main content

How to generate class diagrams pictures in a Django/Open-edX project from console

A class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system’s classes, their attributes, operations (or methods), and the relationships among objects.

https://github.com/django-extensions/django-extensions
Step 1:  Install django extensions

Command: pip install django-extensions

Step 2: Add to installed apps


INSTALLED_APPS = (
    ...
    'django_extensions',
    ...
)

Step 3: Install diagrams generators
You have to choose between two diagram generators:
  • Graphviz or
  • Dotplus
before using the command or you will get:

python manage.py graph_models -a -o myapp_models.png

Note: I prefer to use pydotplus as it easier to install than Graphviz and its dependencies so we use pip install pydotplus.

Command:  pip install pydotplus

Step 4: Generate diagrams
Now we have everything installed and ready to generate diagrams using the command python manage.py graph_models



Command  :: 
python manage.py graph_models -a -o myapp_models.png




This will give use the entire Wagtail class diagram:

Thank for visiting :)




Popular posts from this blog

How to read or extract text data from passport using python utility.

Hi ,  Lets get start with some utility which can be really helpful in extracting the text data from passport documents which can be images, pdf.  So instead of jumping to code directly lets understand the MRZ, & how it works basically. MRZ Parser :                 A machine-readable passport (MRP) is a machine-readable travel document (MRTD) with the data on the identity page encoded in optical character recognition format Most travel passports worldwide are MRPs.  It can have 2 lines or 3 lines of machine-readable data. This method allows to process MRZ written in accordance with ICAO Document 9303 (endorsed by the International Organization for Standardization and the International Electrotechnical Commission as ISO/IEC 7501-1)). Some applications will need to be able to scan such data of someway, so one of the easiest methods is to recognize it from an image file. I 'll show you how to retrieve the MRZ infor...

Open edX Step-By-Step Production Installation Guide

Get your first Open edX platform up and running with this detailed step-by-step how-to guide that provides detailed instructions on how to build your AWS EC2 Ubuntu Linux server, execute the Open edX native build scripts, and configure your new platform. The first time I installed an instance of Open edX, in many ways I felt like I was on the outside looking in. The project documentation that exists is very good, but, it assumes an extensive knowledge base that, at the time, I lacked. This article attempts to fill in some of the gaps in that knowledge base, and hopefully, make the Open edX platform more accessible. Note: this article references Bash scripts that are located in this Github repository: https://github.com/lpm0073/edx.ginkgo This is a step-by-step fully automated script to stand up a single-server full-stack production-ready instance of Open edX running on an Amazon Web Services (AWS) EC2 (Elastic Compute Cloud — aka virtual server) R3.Large instance (aka 2-cpu ser...