Visualize all functions and classes in a directory
Project description
Function Finder
Have a complex library? Want to either understand someone elses or make your library easier to understand?
What if you could generate a detailed graph of all the functions and classes in your package. Including links between common functions in multiple files. Now you can
External requirements
- This requires the graphviz library
What files are taken into account?
- .py
- .ipynb (Jupyter notebook)
How to use?
- cd to any directory you want
- Default outputs are in pdf
import functionvis
functionvis.mainrunner()
- Change the format of the outputs
import functionvis
functionvis.mainrunner(".", "svg")
- Run for another directory
import functionvis
functionvis.mainrunner("path-to-dir", "svg")
Outputs
- Graph of all functions/classes and their related links
- Relationships between files
- functions.pdf (With all the functions)
- classes.pdf (With all the classes)
- Extension can be configured
- Saved in project dir
Outputs supported
- png
- svg
- jpg
- Others might work so just try
Examples
Check the repo for examples repo
FAQ
Not Working
- Have you installed graphviz?
- Do you have jupytext and graphviz installed
- Are you trying for python files?
Windows?
- I cant check the compatibility but it should work
Where are the outputs?
- Wherever you opened python from
- Or wherever you put the first argument from
Can I convert this to other languages?
- Yes please. Contributions are welcome
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
functionvis-0.1.6.tar.gz
(3.7 kB
view hashes)
Built Distribution
Close
Hashes for functionvis-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 750a4e25f5a789813076285aec692b25748b1e2ee0b1c6d2bea1411d6516f3f4 |
|
MD5 | 66a507981e01a925b07eb0ac8e192ec5 |
|
BLAKE2b-256 | 0a6cb3a949832bb492ca23a96767045a07b10eb32cc36bebc6b557ee089225b9 |