https://github.com/utility-code/functionfinder
Visualize libraries easily
https://github.com/utility-code/functionfinder
library python visualize
Last synced: 4 months ago
JSON representation
Visualize libraries easily
- Host: GitHub
- URL: https://github.com/utility-code/functionfinder
- Owner: utility-code
- License: mit
- Created: 2020-10-30T12:44:49.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-16T19:22:39.000Z (about 5 years ago)
- Last Synced: 2025-09-15T03:41:35.884Z (4 months ago)
- Topics: library, python, visualize
- Language: Python
- Homepage:
- Size: 250 KB
- Stars: 15
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Function Finder
-------
An efficient Python library to help you to visually keep track fo your functions and classes
It aims to make easier to work with those libraries with so many files that one usually
loses track of where which function or class comes from
Example Usage
-------------
> This also takes Jupyter notebooks into account
import functionvis
functionvis.mainrunner()
In case you want to change the output on a specific format
import functionvis
functionvis.mainrunner(".", "svg")
You can also specify the path
import functionvis
functionvis.mainrunner("path-to-dir", "svg")
Install
-------
The latest stable version can always be installed or updated via [pip](https://pypi.org/project/functionvis/):
$ pip install functionvis
Make sure to also install the requirements (Pathlib, graphviz, jupytext):
$ pip install graphviz==0.14.2
$ Pip install jupytext==1.6.0
$ pip install pathlib
If the above fails for graphviz (If you have linux you can get it from apt/aur ; For windows install it from their site)
For conda users:
conda create --name python=3.6
pip install functionvis
Pip install jupytext==1.6.0
Pip install fire
conda install graphviz python-graphviz
Supports
-------
- .py (Normal python file)
- .ipynb (If you have it for python that is)
Outputs
-------
(Find them in your project directory as classes.png and functions.png)
- Functions
- Modules
supported Outputs format
-------
| Format | Suported (tested) |
| ------------- |:-------------:|
| pdf | YES |
| png | YES |
| svg | YES |
| jpg | YES |
| gif | YES |
ToDo + Contributions
-------
## Contribution Rules
- Contributions are welcome :)
- If you want to add support for a new language/add specific functions, use the testing branch.
- Be sure to add a proper explanation with each commit.
- Keep your commits short. I cannot go through 100 lines of change at once
- Radical idea? Amazing!! Put it as an issue first
- Suggestion? Add it as an issue / drop a PR
- Did I miss something? Let me know.
## ToDo
- Other languages such as Julia/C/Java etc.
- Bugs will be squashed if you tell me what they are