Skip to content

Sumit112192/Class-Heirarchy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Class Heirarchy

Project Image

No need to search for class inheritance any more.


Table of Contents


Description

We are aiming to create a python script that can generate a class heirarchy tree of a library/program(written in python). Specifically the tree structure of your overall code by specifying inheritance in the classes, present in the program.

Technologies

  • Python
  • networkx
  • graphviz
  • Unix command line tools (find, grep, xargs)

Back To The Top


Installation

Installation of pip and python3

Install the following python packages.

pip install networkx
pip install pydot

We would also be needing the graphviz software for the script to run.

Install from here

How To Use

git clone or download the python library from github you want to create Class Heirarchy diagram of.

Say I downloaded the manim library from github and moved the folder to the current folder where class_heeirarchy.py file exists.

Run

python class_heirarchy.py manim output

where manim is the folder containing all my .py files of the library and output is the output pdf name i.e output.pdf


References


Back To The Top


License

MIT License

Copyright (c) 2022 Sumit Gupta

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back To The Top


Author Info

Back To The Top

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages