Skip to content

Commit 58707ee

Browse files
authored
readme.rst edited
1 parent d20686a commit 58707ee

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
CodeGraph
22
=========
33

4+
|badge1| |badge2| |badge3|
5+
6+
.. |badge1| image:: https://img.shields.io/pypi/v/codegraph
7+
.. |badge2| image:: https://img.shields.io/pypi/l/codegraph
8+
.. |badge3| image:: https://img.shields.io/pypi/pyversions/codegraph
9+
410
Tool that create a graph of code to show dependencies between code entities (methods, classes and etc).
511
CodeGraph does not execute code, it is based only on lex and syntax parse, so it not need to install
612
all your code dependencies.
@@ -23,11 +29,19 @@ Pass '-o' flag if you want only print dependencies in console and don't want gra
2329
cg /path/to/your_python_code -o
2430

2531

32+
Visualisation samples
33+
*********************
2634

27-
![Code Graph - Code with not used module](/docs/img/code_with_trash_module.png?raw=true "Code with not used module")
28-
![Code Graph - Code there all modules linked together](/docs/img/normal_code.png?raw=true "Code with modules that linked together")
35+
.. image:: codegraph/docs/img/code_with_trash_module.png
36+
:width: 300
37+
:alt: Code with not used module
38+
39+
.. image:: codegraph/docs/img/normal_code.png
40+
:width: 300
41+
:alt: Code there all modules linked together
2942

3043
TODO:
44+
*****
3145
1. Create normal readme
3246
2. Add tests
3347
3. Add possibility to work with any code based (not depend on Python language only)
@@ -37,4 +51,4 @@ TODO:
3751
Contributing:
3852
Open PR with improvements that you want to add
3953

40-
If you have any questions - write me xnuinside@gmail.com
54+
If you have any questions - write me xnuinside@gmail.com

0 commit comments

Comments
 (0)