kebab-mai-haddi / gruml Goto Github PK

Generates UML diagram for a given source code

License: MIT License

Python 98.63% Dockerfile 1.37%

gruml's Introduction

GRUML

Tired of collaborating over UML diagrams or don't use them at all? We feel you. We know how tedious it is to use or even think of UML diagrams for large codebases.Thus, we bring you RUML - Rectangular UML diagrams. You can know what all classes are dependent on one another, who inherits from whom, what is the flow of control of your codebase when executed in different scenarios - all in an Excel sheet.

Installation

Docker

Click here to install Docker.

Install GRUML

docker run -d --name gruml avisrivastava254084/gruml:latest

Running the application

docker exec gruml python3 generate_ruml.py --help

Example

A simple example

docker exec gruml python3 generate_ruml.py https://github.com/kebab-mai-haddi/python3-class-inheritance-dependency-example -u test_cli -d driver -dp driver.py -df main_2

docker cp gruml://home/ubuntu/generate_uml/Use_Case_test_cliDependency_2.xlsx demo_video.xlsx

Open the demo_video.xlsx file and see the visualization of the codebase.

gruml's People

Contributors

Stargazers

Watchers

Forkers

bellyfat

gruml's Issues

Manually test application on EC2

Market Launch

We have to launch GRUML to the world out there as an open-source tool. There are two ways:

Ideal Way
The ideal way would be to take the best route of Python packaging and have our users install gruml as: pip3 install gruml and then they can use gruml as it is. This will take time as we want some changes in cpython which are currently a WIP and I will try to finish this off from my end as soon as possible. But taking this route will not let us release GRUML by the end of April.
The faster and temporary way
GRUML is completed and it should be launched as soon as possible to further improve. It adds so much value (In My Honest Opinion) that it should be launched right away regardless of whether we make further changes to it. And so, I propose to i) spin up an ec2-instance on AWS (or GCP, etc), ii) let users interact with gruml via a Flask app or something iii) Users will have an output which would be a link of the GRUML CSV file with(out) sequence diagram. Our web interface will basically ask them for all the input needed. This method is good because it will have our users ( and surveyors ) not need to install anything and just explore GRUML on their source code. However, our users will have to provide a Github link of their source code directory. I think we can expect that. As an addition, we will provide GRUML outputs of 10 projects in Python (Pandas, Spyder, etc) for our users to explore.