utility-code · SubhadityaMukherjee · Nov 11, 2020 · Nov 11, 2020
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # Function Finder 
  -----
-
+
+ - This is now on pypi!!! [Link](https://pypi.org/project/functionvis/)
+
  - Every found a library with so many files you lose track of which function/class comes from where?
  - What if you could see it visually :o
 
@@ -12,25 +14,15 @@
 - .ipynb (If you have it for python that is)
 
 ## How to run
-
+
+ - Do a pip install functionvis
  - Get requirements (Pathlib, graphviz, jupytext)
  - Install graphviz (If you have linux you can get it from apt/aur ; For windows install it from their site)
- ```
- pip install -r requirements.txt
- ```
- - Just invoke the main.py file with the argument as the directory which you want to visualize
- - eg:
- ```py
- python main.py -d "Your directory path"
- ```
- - Arguments (Default is True. Change only if you want False)
-   - -f Generate for Functions
-   - -c Generate for Classes
-   - -fo Format to save graph. **Default png. If you have a "huge" library. Use pdf or svg**
-   - ef:
-   ```py
-    python main.py -fc -d "../datafly/" 
-   ```
+ - python
+ - ```py
+    import functionvis
+    functionvis.mainrunner()
+    ```
 > This also takes Jupyter notebooks into account
 
  ## Outputs

diff --git a/build/lib/functionfinder/__init__.py b/build/lib/functionfinder/__init__.py
@@ -0,0 +1,13 @@
+import fire
+from .main import *
+
+if __name__=='__main__':
+    fire.Fire(mainrunner)
+
+
+
+
+
+
+
+
diff --git a/main.py → build/lib/functionfinder/main.py b/main.py → build/lib/functionfinder/main.py
@@ -1,21 +1,23 @@
 #!/usr/bin/env python3
 
 from pathlib import Path
-import argparse
+# import argparse
 import ast
 from graphviz import Digraph
-import jupytext
+# import jupytext
 import os
+# import fire
 
-opt = argparse.ArgumentParser("Function grapher")
-opt.add_argument("-d", "--dir", help="Enter directory")
-opt.add_argument(
-    "-f", type=bool, help="Generate for functions. True by default", default=True)
-opt.add_argument(
-    "-c", type=bool, help="Generate for classes. True by default", default=True)
-opt.add_argument(
-    "-fo", help="Format to save. Default pdf. Choose between svg/pdf/png etc.", default="png")
-args = opt.parse_args()
+# opt = argparse.ArgumentParser("Function grapher")
+# opt.add_argument("-d", "--dir", help="Enter directory")
+# opt.add_argument(
+#     "-f", type=bool, help="Generate for functions. True by default", default=True)
+# opt.add_argument(
+#     "-c", type=bool, help="Generate for classes. True by default", default=True)
+# opt.add_argument(
+#     "-fo", help="Format to save. Default pdf. Choose between svg/pdf/png etc.", default="png")
+# args = opt.parse_args()
+#
 
 
 def top_level_functions(body):
@@ -38,32 +40,32 @@ def get_files(file_path):
     print("[INFO] Creating list of files")
     all_files = Path(file_path)
     try:
-        ipynb_files = [ path for path in all_files.rglob("*.ipynb") ]
+        ipynb_files = [path for path in all_files.rglob("*.ipynb")]
         tmp = [os.system(f"jupytext --to py {fil}") for fil in ipynb_files]
     except:
         ipynb_files = []
-    
+
     py_files = {path: [] for path in all_files.rglob("*.py")}
     fils = list(py_files.keys())
-    
+
     for fil in fils:
         try:
             py_files[fil] = get_all_functions(fil)
         except SyntaxError:
             print(f"Could not read file: {fil}")
-            
+
     print("[INFO] Done creating list of files")
-    
+
     for fil in ipynb_files:
         if "checkpoint" not in str(fil):
             os.remove(str(fil).replace(".ipynb", ".py"))
     return py_files
 
 
-def graph_creator(dictionary, retType="functions"):
+def graph_creator(dictionary, dir, fo, retType="functions"):
     # Create the graph
     dot = Digraph("Project")
-    dot.format = args.fo
+    dot.format = fo
     # Create node names
     for file in dictionary:
         dot.node(file.name)
@@ -76,12 +78,16 @@ def graph_creator(dictionary, retType="functions"):
 
     print(dot.source)
     # Save graphs in required location
-    dot.render(Path.joinpath(Path(args.dir), retType))
-    Path.unlink(Path.joinpath(Path(args.dir), retType))
+    dot.render(Path.joinpath(Path(dir), retType))
+    Path.unlink(Path.joinpath(Path(dir), retType))
     print("[INFO] Saved Graph")
 
 
-processed = get_files(args.dir)
-graph_creator(processed, "functions")
-graph_creator(processed, "classes")
-print("[INFO] Please check the project directory for the graphs")
+def mainrunner(dir=".", fo="pdf"):
+    processed = get_files(dir)
+    graph_creator(processed, dir, fo, "functions")
+    graph_creator(processed, dir, fo, "classes")
+    print("[INFO] Please check the project directory for the graphs")
+
+# if __name__ == '__main__':
+    # fire.Fire(mainrunner)
diff --git a/build/lib/functionfinder/runner.py b/build/lib/functionfinder/runner.py
@@ -0,0 +1,3 @@
+from .main import *
+
+fire.Fire(mainrunner)
diff --git a/build/lib/functionvis/__init__.py b/build/lib/functionvis/__init__.py
@@ -0,0 +1,13 @@
+import fire
+from .main import *
+
+if __name__=='__main__':
+    fire.Fire(mainrunner)
+
+
+
+
+
+
+
+
diff --git a/build/lib/functionvis/main.py b/build/lib/functionvis/main.py
@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+
+from pathlib import Path
+# import argparse
+import ast
+from graphviz import Digraph
+# import jupytext
+import os
+# import fire
+
+# opt = argparse.ArgumentParser("Function grapher")
+# opt.add_argument("-d", "--dir", help="Enter directory")
+# opt.add_argument(
+#     "-f", type=bool, help="Generate for functions. True by default", default=True)
+# opt.add_argument(
+#     "-c", type=bool, help="Generate for classes. True by default", default=True)
+# opt.add_argument(
+#     "-fo", help="Format to save. Default pdf. Choose between svg/pdf/png etc.", default="png")
+# args = opt.parse_args()
+#
+
+
+def top_level_functions(body):
+    return (f for f in body if isinstance(f, ast.FunctionDef))
+
+
+def top_level_classes(body):
+    return (f for f in body if isinstance(f, ast.ClassDef))
+
+
+def get_all_functions(filename):
+    with open(str(filename), 'r') as f:
+        temp = ast.parse(f.read())
+        classes = [func.name for func in top_level_classes(temp.body)]
+        functions = [func.name for func in top_level_functions(temp.body)]
+        return {"classes": classes, "functions": functions}
+
+
+def get_files(file_path):
+    print("[INFO] Creating list of files")
+    all_files = Path(file_path)
+    try:
+        ipynb_files = [path for path in all_files.rglob("*.ipynb")]
+        tmp = [os.system(f"jupytext --to py {fil}") for fil in ipynb_files]
+    except:
+        ipynb_files = []
+
+    py_files = {path: [] for path in all_files.rglob("*.py")}
+    fils = list(py_files.keys())
+
+    for fil in fils:
+        try:
+            py_files[fil] = get_all_functions(fil)
+        except SyntaxError:
+            print(f"Could not read file: {fil}")
+
+    print("[INFO] Done creating list of files")
+
+    for fil in ipynb_files:
+        if "checkpoint" not in str(fil):
+            os.remove(str(fil).replace(".ipynb", ".py"))
+    return py_files
+
+
+def graph_creator(dictionary, dir, fo, retType="functions"):
+    # Create the graph
+    dot = Digraph("Project")
+    dot.format = fo
+    # Create node names
+    for file in dictionary:
+        dot.node(file.name)
+        # Add functions/classes
+        try:
+            for methods in dictionary[file][retType]:
+                dot.edge(file.name, methods)
+        except TypeError:
+            pass
+
+    print(dot.source)
+    # Save graphs in required location
+    dot.render(Path.joinpath(Path(dir), retType))
+    Path.unlink(Path.joinpath(Path(dir), retType))
+    print("[INFO] Saved Graph")
+
+
+def mainrunner(dir=".", fo="pdf"):
+    processed = get_files(dir)
+    graph_creator(processed, dir, fo, "functions")
+    graph_creator(processed, dir, fo, "classes")
+    print("[INFO] Please check the project directory for the graphs")
+
+# if __name__ == '__main__':
+    # fire.Fire(mainrunner)
diff --git a/build/lib/functionvis/runner.py b/build/lib/functionvis/runner.py
@@ -0,0 +1,3 @@
+from .main import *
+
+fire.Fire(mainrunner)
diff --git a/classes.pdf b/classes.pdf
diff --git a/dist/functionvis-0.1.3-py3-none-any.whl b/dist/functionvis-0.1.3-py3-none-any.whl
diff --git a/dist/functionvis-0.1.3.tar.gz b/dist/functionvis-0.1.3.tar.gz
diff --git a/functions.pdf b/functions.pdf
diff --git a/functionvis.egg-info/PKG-INFO b/functionvis.egg-info/PKG-INFO
@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: functionvis
+Version: 0.1.3
+Summary: Visualize all functions and classes in a directory
+Home-page: https://github.com/SubhadityaMukherjee/functionFinder
+Author: Subhaditya Mukherjee
+Author-email: [email protected]
+License: MIT
+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
+
+        # What files are taken into account?
+
+        - .py
+        - .ipynb (Jupyter notebook)
+
+        # Outputs
+
+        - functions.pdf
+        - classes.pdf
+        - Extension can be configured
+
+        # How to use?
+
+        - cd to any directory you want
+        - Default outputs are in pdf
+        ```py
+        import functionfinder
+        functionfinder.runner()
+        ```
+        - Change the format of the outputs
+        ```py
+        import functionfinder
+        functionfinder.runner(".", "svg")
+        ```
+
+        # Example
+
+        - Functions
+        ![](./classes.png)
+
+        - Modules
+        ![](./functions.png)
+
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
diff --git a/functionvis.egg-info/SOURCES.txt b/functionvis.egg-info/SOURCES.txt
@@ -0,0 +1,10 @@
+README.md
+setup.py
+functionvis/__init__.py
+functionvis/main.py
+functionvis/runner.py
+functionvis.egg-info/PKG-INFO
+functionvis.egg-info/SOURCES.txt
+functionvis.egg-info/dependency_links.txt
+functionvis.egg-info/not-zip-safe
+functionvis.egg-info/top_level.txt
diff --git a/functionvis.egg-info/dependency_links.txt b/functionvis.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/functionvis.egg-info/not-zip-safe b/functionvis.egg-info/not-zip-safe
@@ -0,0 +1 @@
+
diff --git a/functionvis.egg-info/top_level.txt b/functionvis.egg-info/top_level.txt
@@ -0,0 +1 @@
+functionvis
diff --git a/functionvis/__init__.py b/functionvis/__init__.py
@@ -0,0 +1,13 @@
+import fire
+from .main import *
+
+if __name__=='__main__':
+    fire.Fire(mainrunner)
+
+
+
+
+
+
+
+
diff --git a/functionvis/__pycache__/__init__.cpython-38.pyc b/functionvis/__pycache__/__init__.cpython-38.pyc
diff --git a/functionvis/__pycache__/main.cpython-38.pyc b/functionvis/__pycache__/main.cpython-38.pyc