add full path to images

Author: xnuinside

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+known_third_party = clifier,matplotlib,networkx,pytest

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+    - id: seed-isort-config
+-   repo: https://github.com/pycqa/isort
+    rev: 5.4.2
+    hooks:
+      - id: isort
+-   repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3.8
+-   repo: https://github.com/PyCQA/flake8
+    rev: 3.8.3
+    hooks:
+    - id: flake8

CHANGELOG.txt

@@ -4,4 +4,4 @@
 1. Command line tool name changed from 'cg' to 'codegraph'.
 2. Updated versions of dependencies
 3. Minimal supported python version up to 3.8
-4. Cleaned up code
+4. Added some unit & functional tests

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+### Install all dependencies
+
+Project uses poetry as a package manager, so if you don't have it - first of all read official doc & install it: https://python-poetry.org/docs/
+
+
+
+```
+    # after that do install
+    poetry install
+
+    # and activate project shell
+    poetry shell
+
+```
+
+### Install pre-commit hook
+
+To follow code styles and successfully pass github pipelines install pre-commit hooks
+
+```
+
+    pre-commit install
+
+```

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Iuliia Volkova [[email protected]]
+
+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.

README.md

@@ -42,20 +42,23 @@ Pass '-o' flag if you want only print dependencies in console and don't want gra
 If you want to change view and play with graph output - you can check 'vizualyzer.py'
 and play with matplotlib and networkX settings.
 
-In default view - red line show dependencies between entities in different modules. Green - entities in module.
+### Colors meanings 
+In default view - **red line** show dependencies between entities in different modules.
+**Green** - links between objects/functions inside same module.
 
-![Graph visualisation](/docs/img/graph_visualisation.png "Graph visualisation")
+![Graph visualisation](https://github.com/xnuinside/codegraph/blob/main/docs/img/graph_visualisation.png "Graph visualisation")
 
-![ Code with not used module](/docs/img/code_with_trash_module.png "Code with not used module")
+![ Code with not used module](https://github.com/xnuinside/codegraph/blob/main/docs/img/code_with_trash_module.png "Code with not used module")
 
-![Code there all modules linked together](/docs/img/normal_code.png "Code there all modules linked together")
+![Code there all modules linked together](https://github.com/xnuinside/codegraph/blob/main/docs/img/normal_code.png "Code there all modules linked together")
 
 ### TODO
 
     1. Create normal readme
     2. Add tests
     3. Work on visual part of Graph (now it is not very user friendly)
     4. Add support to variables (names) as entities
+    5. Split usage & inheritance as a different cases
 
 ## Changelog
 **v0.1.0**
@@ -64,4 +67,4 @@ In default view - red line show dependencies between entities in different modul
 1. Command line tool name changed from 'cg' to 'codegraph'.
 2. Updated versions of dependencies
 3. Minimal supported python version up to 3.8
-4. Cleaned up code
+4. Added some unit & functional tests

codegraph/core.py

@@ -4,7 +4,7 @@
 from typing import Dict, List, Text, Tuple
 
 from codegraph.parser import Import, create_objects_array
-from codegraph.utils import get_paths_list
+from codegraph.utils import get_python_paths_list
 
 aliases = {}
 
@@ -36,7 +36,7 @@ def get_code_objects(paths_list: List) -> Dict:
 
 class CodeGraph:
     def __init__(self, args: Namespace):
-        self.paths_list = get_paths_list(args.paths)
+        self.paths_list = get_python_paths_list(args.paths)
         # get py modules list data
         self.modules_data = get_code_objects(self.paths_list)
 

codegraph/parser.py

@@ -97,6 +97,7 @@ def create_objects_array(fname, source):  # noqa: C901
     stack = []
 
     g = tokenize.generate_tokens(f.readline)
+
     try:
         new_lines = 0
         imports = None

codegraph/utils.py

@@ -1,17 +1,29 @@
 import glob
-from typing import List
+from pathlib import Path
+from typing import List, Union
 
 
-def get_paths_list(paths: List) -> List:
+def get_python_paths_list(paths: Union[str, List]) -> List:
     """
         return list of paths to python files, that found in provided path
     :param paths: paths to folder or python file that need to tests
     :return:
     """
+    if isinstance(paths, str):
+        paths = [paths]
     if len(paths) == 1 and paths[0].endswith(".py"):
-        return [paths[0]]
+        # mean provided path to one python module
+        path = Path(paths[0]).absolute()
+        if not path.exists():
+            raise ValueError(f"Path {path.as_posix()} does not exists")
+        return [path.as_posix()]
+
     paths_list = []
     for path in paths:
+        path = Path(path).absolute()
+        if not path.exists():
+            raise ValueError(f"Path {path.as_posix()} does not exists")
+        path = path.as_posix()
         paths_list += [
             path
             for path in glob.glob(path + "/*", recursive=True)

codegraph/vizualyzer.py

@@ -5,26 +5,41 @@
 import networkx as nx
 
 
+def process_module_in_graph(module: Dict[str, list], module_links: list, G: nx.DiGraph):
+    _module = os.path.basename(module)
+
+    module_edges = []
+
+    sub_edges = []
+    for entity in module_links:
+        module_edges.append((_module, entity))
+        for dep in module_links[entity]:
+            if "." in dep:
+                dep = dep.split(".")[1].replace(".", ".py")
+            sub_edges.append((entity, dep))
+        G.add_edges_from(sub_edges)
+    if not module_links:
+        G.add_node(_module)
+    G.add_edges_from(module_edges)
+    return module_edges, sub_edges
+
+
 def draw_graph(modules_entities: Dict) -> None:
+
     G = nx.DiGraph()
+
     module_edges_all = []
+
     sub_edges_all = []
+
     for module in modules_entities:
-        _module = os.path.basename(module)
-        module_edges = []
-        for entity in modules_entities[module]:
-            sub_edges = []
-            module_edges.append((_module, entity))
-            for dep in modules_entities[module][entity]:
-                if "." in dep:
-                    dep = dep.split(".")[1].replace(".", ".py")
-                sub_edges.append((entity, dep))
-            G.add_edges_from(sub_edges)
-            sub_edges_all += sub_edges
-        if not modules_entities[module]:
-            G.add_node(_module)
-        G.add_edges_from(module_edges)
-        module_edges_all += module_edges
+        new_module_edges_all, new_edges_all = process_module_in_graph(
+            module, modules_entities[module], G
+        )
+
+        module_edges_all += new_module_edges_all
+        sub_edges_all += new_edges_all
+
     pos = nx.spring_layout(G)
     module_list = [os.path.basename(module) for module in modules_entities]
     module_list_labels = {module_name: module_name for module_name in module_list}