ArchLens 0.2__py3-none-any.whl

archlens-0.2.data/data/config.schema.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "required": ["name", "rootFolder", "views"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the project",
+      "minLength": 1
+    },
+    "rootFolder": {
+      "type": "string",
+      "description": "Point to the root package of the project",
+      "minLength": 1
+    },
+    "github": {
+      "type": "object",
+      "description": "Information about the GitHub repository for the project",
+      "required": ["url", "branch"],
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "The URL of the GitHub repository for the project"
+        },
+        "branch": {
+          "type": "string",
+          "description": "The name of the branch to use for the GitHub repository"
+        }
+      }
+    },
+    "SaveLocation": {
+      "type": "string",
+      "description": "The folder to which the diagrams should be saved in. If the folder does not exists it will be created",
+      "default": "./diagrams/"
+    },
+    "showDependencyCount": {
+      "type": "boolean",
+      "description": "If to showcase the number of dependencies between packages"
+    },
+    "packageColor": {
+      "type": "string",
+      "enum": ["#GoldenRod", "#Azure", ""]
+    },
+    "views": {
+      "type": "object",
+      "description": "Defines the views available",
+      "patternProperties": {
+        ".*": {
+          "description": "The name of the view",
+          "type": "object",
+          "properties": {
+            "packages": {
+              "description": "The packages to include in the view. Leave empty to include all packages",
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "pattern": "^[A-Za-z0-9._-]+$"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "path": {
+                        "type": "string",
+                        "pattern": "^[A-Za-z0-9._\\-]+|[*]$"
+                      },
+                      "depth": {
+                        "type": "integer"
+                      }
+                    },
+                    "required": ["path", "depth"]
+                  }
+                ]
+              }
+            },
+            "ignorePackages": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^[A-Za-z0-9._\\-\\/*]+$"
+              },
+              "description": "Defines the packages to ignore"
+            },
+            "usePackagePathAsLabel": {
+              "type": "boolean",
+              "description": "If true, paths of each package will be displayed, if false only package name will be displayed"
+            }
+          }
+        }
+      }
+    }
+  }
+}

archlens-0.2.data/data/config.template.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://raw.githubusercontent.com/archlens/ArchLens/master/src/config.schema.json",
+  "name": "",
+  "rootFolder": "",
+  "github": {
+    "url": "",
+    "branch": "main"
+  },
+  "saveLocation": "./diagrams/",
+  "views": {
+    "completeView": {
+      "packages": [],
+      "ignorePackages": []
+    }
+  }
+}

archlens-0.2.dist-info/METADATA

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: ArchLens
+Version: 0.2
+Summary: Designed for visualizing package dependencies and highlighting differences between branches in GitHub pull requests. It offers customization options to tailor package views.
+Home-page: https://github.com/archlens/ArchLens
+Author: The ArchLens Team
+Author-email: mlun@itu.dk
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: plantuml
+Requires-Dist: typer
+Requires-Dist: astroid
+Requires-Dist: six
+Requires-Dist: requests
+Requires-Dist: jsonschema
+Requires-Dist: gitpython
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+This is the long description

archlens-0.2.dist-info/RECORD

@@ -0,0 +1,31 @@
+archlens-0.2.data/data/config.schema.json,sha256=WexuktJolnluIvoOE4YGWoxY4rRlU9lr3f0L2lKELWA,2901
+archlens-0.2.data/data/config.template.json,sha256=mdJse5TRDy_V0KpN9UFaFRFo23ZbOQ32Y4hwJgDJj6c,318
+src/__init__.py,sha256=-d7TWFKkXpRRhH9rz7n-2n623B_HqgfMd1rpbRfpXCM,64
+src/cli_interface.py,sha256=NtjNKVw88HTwLnEbJCP893Ta-yOzHcQkUWzKdeYvbHA,5084
+src/config.schema.json,sha256=WexuktJolnluIvoOE4YGWoxY4rRlU9lr3f0L2lKELWA,2901
+src/config.template.json,sha256=mdJse5TRDy_V0KpN9UFaFRFo23ZbOQ32Y4hwJgDJj6c,318
+src/main.py,sha256=YbJCHt-qZHNxtl9z1QYOesw8b8OLkQKsML2QmZTHNVA,30
+src/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/core/bt_file.py,sha256=ugNwjTiiisqaXr0iQJ4IG9s2W3mpuv_wPT23eOU25Jg,2768
+src/core/bt_graph.py,sha256=TfDEbMcDFjsBe1A2_g610FMKG7zM6Rf6i1U0D3SAiK0,3859
+src/core/bt_module.py,sha256=cGtKiJxazojyjmPEoTHtk-zFSE_12lY_zLjXh3Tad3s,3147
+src/git_integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/git_integration/fetch_git.py,sha256=yqDWi_fk-zxkdApmE3SKEmx0uXcBux1Fw3K0Mhh8w6g,244
+src/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/providers/json/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/providers/json/json_render.py,sha256=iCPtE8thUFcOzDZNyET0VvU6E4uCcT-D9HmoWx3rono,1465
+src/providers/plantuml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/providers/plantuml/pu_render.py,sha256=WEozrq9AWUr4Cg7LqhyVoT04Vg4Z8QzOT_5nTYSEUSM,1820
+src/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/utils/config_manager_singleton.py,sha256=n3Vp-JSaoXpD5ukBUgKxXdmTWIlapth8gZ53C0WEYsY,424
+src/utils/functions.py,sha256=TbLO4o9qJ-iaioN1S0HDE70AAFm7SxQaHjGgd-nNrSo,1520
+src/utils/path_manager_singleton.py,sha256=VhKzS82tRZ6QNJTq6tQKJmUSHyr29yrGmxZXdSmpJn0,1850
+src/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/views/utils.py,sha256=BJi7RcURuA3oOLrl8g6DdROVIjVtrJLoq0ZuYydQU_4,329
+src/views/view_entities.py,sha256=-LbDYMyaJr-QMPQNR17TiVd3kzbc6PbGlfn7N7tZsOg,7918
+src/views/view_manager.py,sha256=-mwxDkYOMb23UiqcFNyB1dR0h_e61dsY8_sRf5NQIKI,10834
+archlens-0.2.dist-info/METADATA,sha256=0ZBD6oQNweOw0x28StGsNWbAnNpzj6C-kDAT2h3ElKc,764
+archlens-0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+archlens-0.2.dist-info/entry_points.txt,sha256=eOn74xvh44lrsjdvJ89_1uzx7XB0DeAaMwYnWEjI748,52
+archlens-0.2.dist-info/top_level.txt,sha256=74rtVfumQlgAPzR5_2CgYN24MB0XARCg0t-gzk6gTrM,4
+archlens-0.2.dist-info/RECORD,,

archlens-0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

archlens-0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+archlens = src.cli_interface:main

archlens-0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+src

src/__init__.py

@@ -0,0 +1,4 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath(".."))

src/cli_interface.py

@@ -0,0 +1,176 @@
+import typer
+import json
+import os
+import requests
+import jsonschema
+import tempfile
+import shutil
+from pathlib import Path
+from src.providers.json.json_render import save_json, save_json_diff
+from src.providers.plantuml.pu_render import save_plant_uml, save_plant_uml_diff
+from src.utils.path_manager_singleton import PathManagerSingleton
+
+# from src.utils.functions import verify_config_options
+from src.utils.config_manager_singleton import ConfigManagerSingleton
+
+from src.views.view_manager import render_views, render_diff_views
+
+from src.core.bt_graph import BTGraph
+
+from src.git_integration.fetch_git import fetch_git_repo
+
+from astroid.manager import AstroidManager
+
+import astroid
+
+astroid.MANAGER = None
+
+app = typer.Typer(add_completion=True)
+
+
+@app.command()
+def render(config_path: str = "archlens.json"):
+    config = read_config_file(config_path)
+
+    mt_path_manager = PathManagerSingleton()
+    mt_path_manager.setup(config)
+
+    am = _create_astroid()
+    g = BTGraph(am)
+    g.build_graph(config)
+
+    render_views(g, config, save_plant_uml)
+
+
+@app.command()
+def render_json(config_path: str = "archlens.json"):
+    config = read_config_file(config_path)
+
+    mt_path_manager = PathManagerSingleton()
+    mt_path_manager.setup(config)
+
+    am = _create_astroid()
+    g = BTGraph(am)
+    g.build_graph(config)
+
+    render_views(g, config, save_json)
+
+
+def _create_astroid():
+    am = AstroidManager()
+    am.brain["astroid_cache"] = {}
+    return am
+
+
+@app.command()
+def render_diff(config_path: str = "archlens.json"):
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        print("Created temporary directory:", tmp_dir)
+        config = read_config_file(config_path)
+
+        fetch_git_repo(tmp_dir, config["github"]["url"], config["github"]["branch"])
+
+        shutil.copyfile(config_path, os.path.join(tmp_dir, "archlens.json"))
+
+        config_git = read_config_file(os.path.join(tmp_dir, "archlens.json"))
+
+        path_manager = PathManagerSingleton()
+        path_manager.setup(config, config_git)
+
+        local_am = _create_astroid()
+        local_graph = BTGraph(local_am)
+        local_graph.build_graph(config)
+        # verify_config_options(config, g)
+
+        remote_am = _create_astroid()
+        remote_graph = BTGraph(remote_am)
+        remote_graph.build_graph(config_git)
+        # verify_config_options(config_git, g_git)
+
+        render_diff_views(local_graph, remote_graph, config, save_plant_uml_diff)
+
+
+@app.command()
+def render_diff_json(config_path: str = "archlens.json"):
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        print("Created temporary directory:", tmp_dir)
+        config = read_config_file(config_path)
+
+        fetch_git_repo(tmp_dir, config["github"]["url"], config["github"]["branch"])
+
+        shutil.copyfile(config_path, os.path.join(tmp_dir, "archlens.json"))
+
+        config_git = read_config_file(os.path.join(tmp_dir, "archlens.json"))
+
+        path_manager = PathManagerSingleton()
+        path_manager.setup(config, config_git)
+
+        local_am = _create_astroid()
+        local_graph = BTGraph(local_am)
+        local_graph.build_graph(config)
+        # verify_config_options(config, g)
+
+        remote_am = _create_astroid()
+        remote_graph = BTGraph(remote_am)
+        remote_graph.build_graph(config_git)
+        # verify_config_options(config_git, g_git)
+
+        render_diff_views(local_graph, remote_graph, config, save_json_diff)
+
+
+@app.command()
+def init(config_path="./archlens.json"):
+    os.makedirs(os.path.dirname(config_path), exist_ok=True)
+    template_path = os.path.join(os.path.dirname(__file__), "config.template.json")
+    schema = None
+    with open(template_path, "r") as f:
+        schema = json.load(f)
+
+    schema["name"] = os.path.basename(os.getcwd())
+    with open(config_path, "w") as outfile:
+        json.dump(schema, outfile, indent=4)
+
+
+@app.command()
+def create_action():
+    action_url = "https://raw.githubusercontent.com/archlens/ArchLens/master/.github/workflows/render-diff-on-pr.yml"
+    action_path = Path(".github/workflows/render-diff-on-pr.yml")
+    typer.secho(f"Creating the action at {action_path}", fg="green")
+    action_path.parent.mkdir(parents=True, exist_ok=True)
+    action = requests.get(action_url).text
+
+    with open(action_path, "w") as f:
+        f.write(action)
+
+
+def read_config_file(config_path):
+    config = None
+    with open(config_path, "r") as f:
+        config = json.load(f)
+
+    config_schema = None
+    schema_path = os.path.join(os.path.dirname(__file__), "config.schema.json")
+    with open(schema_path) as fp:
+        config_schema = json.load(fp)
+
+    if not os.getenv("MT_DEBUG"):
+        jsonschema.validate(instance=config, schema=config_schema)
+
+    config["_config_path"] = os.path.dirname(os.path.abspath(config_path))
+
+    config["saveLocation"] = os.path.normpath(
+        os.path.join(config["_config_path"], config["saveLocation"])
+    )
+
+    config_manager = ConfigManagerSingleton()
+    config_manager.setup(config)
+
+    return config
+
+
+def main():
+    app()
+
+
+if __name__ == "__main__":
+    main()

src/config.schema.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "required": ["name", "rootFolder", "views"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the project",
+      "minLength": 1
+    },
+    "rootFolder": {
+      "type": "string",
+      "description": "Point to the root package of the project",
+      "minLength": 1
+    },
+    "github": {
+      "type": "object",
+      "description": "Information about the GitHub repository for the project",
+      "required": ["url", "branch"],
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "The URL of the GitHub repository for the project"
+        },
+        "branch": {
+          "type": "string",
+          "description": "The name of the branch to use for the GitHub repository"
+        }
+      }
+    },
+    "SaveLocation": {
+      "type": "string",
+      "description": "The folder to which the diagrams should be saved in. If the folder does not exists it will be created",
+      "default": "./diagrams/"
+    },
+    "showDependencyCount": {
+      "type": "boolean",
+      "description": "If to showcase the number of dependencies between packages"
+    },
+    "packageColor": {
+      "type": "string",
+      "enum": ["#GoldenRod", "#Azure", ""]
+    },
+    "views": {
+      "type": "object",
+      "description": "Defines the views available",
+      "patternProperties": {
+        ".*": {
+          "description": "The name of the view",
+          "type": "object",
+          "properties": {
+            "packages": {
+              "description": "The packages to include in the view. Leave empty to include all packages",
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "pattern": "^[A-Za-z0-9._-]+$"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "path": {
+                        "type": "string",
+                        "pattern": "^[A-Za-z0-9._\\-]+|[*]$"
+                      },
+                      "depth": {
+                        "type": "integer"
+                      }
+                    },
+                    "required": ["path", "depth"]
+                  }
+                ]
+              }
+            },
+            "ignorePackages": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^[A-Za-z0-9._\\-\\/*]+$"
+              },
+              "description": "Defines the packages to ignore"
+            },
+            "usePackagePathAsLabel": {
+              "type": "boolean",
+              "description": "If true, paths of each package will be displayed, if false only package name will be displayed"
+            }
+          }
+        }
+      }
+    }
+  }
+}

src/config.template.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://raw.githubusercontent.com/archlens/ArchLens/master/src/config.schema.json",
+  "name": "",
+  "rootFolder": "",
+  "github": {
+    "url": "",
+    "branch": "main"
+  },
+  "saveLocation": "./diagrams/",
+  "views": {
+    "completeView": {
+      "packages": [],
+      "ignorePackages": []
+    }
+  }
+}

src/core/bt_file.py

@@ -0,0 +1,95 @@
+import astroid
+from astroid.manager import AstroidManager
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from src.core.bt_module import BTModule
+
+
+class BTFile:
+    label: str = ""
+    edge_to: list["BTFile"] = None
+    ast = None
+    module: "BTModule" = None
+    am: AstroidManager
+
+    def __init__(self, label: str, module, am: AstroidManager, code_path: str = None):
+        self.label = label
+        self.ast = None
+        self.am = am
+
+        if code_path is not None:
+            self.ast: astroid.Module = self.am.ast_from_module_name(code_path)
+
+        self.edge_to = []
+        self.module = module
+
+    @property
+    def file(self):
+        if self.ast:
+            return self.ast.file
+        return ""
+
+    @property
+    def uid(self):
+        if self.ast:
+            return self.ast.file
+        else:
+            return self.label
+
+    @property
+    def module_path(self) -> str:
+        if not self.ast:
+            return None
+        return "/".join(self.file.split("/")[:-1])
+
+    def __rshift__(self, other):
+        if isinstance(other, list):
+            existing_edges = set(
+                [edge.file for edge in self.edge_to if edge.file != ""]
+            )
+            new_node_list = filter(lambda e: e.file not in existing_edges, other)
+            self.edge_to.extend([node for node in new_node_list])
+        else:
+            edges = set([edge.file for edge in self.edge_to])
+            if other.file in edges:
+                return
+
+            self.edge_to.append(other)
+
+
+def get_imported_modules(
+    ast: astroid.Module, root_location: str, am: AstroidManager
+) -> list:
+    imported_modules = []
+    for sub_node in ast.body:
+        try:
+            if isinstance(sub_node, astroid.node_classes.ImportFrom):
+                sub_node: astroid.node_classes.ImportFrom = sub_node
+
+                module_node = am.ast_from_module_name(
+                    sub_node.modname,
+                    context_file=root_location,
+                )
+                imported_modules.append(module_node)
+
+            elif isinstance(sub_node, astroid.node_classes.Import):
+                for name, _ in sub_node.names:
+                    try:
+                        module_node = am.ast_from_module_name(
+                            name,
+                            context_file=root_location,
+                        )
+                        imported_modules.append(module_node)
+                    except Exception:
+                        continue
+            elif hasattr(sub_node, "body"):
+                imported_modules.extend(
+                    get_imported_modules(sub_node, root_location, am)
+                )
+
+        except astroid.AstroidImportError:
+            continue
+
+    return imported_modules

src/core/bt_graph.py

@@ -0,0 +1,115 @@
+import json
+
+import astroid
+import sys
+import os
+
+from src.core.bt_file import BTFile, get_imported_modules
+from src.core.bt_module import BTModule
+from astroid.manager import AstroidManager
+
+
+class BTGraph:
+    DEFAULT_SETTINGS = {"diagram_name": "", "project": None}
+    root_module_location: str = None
+    target_project_base_location: str = None
+    root_module = None
+    base_module = None
+    am: AstroidManager = None
+
+    def __init__(self, am: AstroidManager) -> None:
+        self.am = am
+
+    def build_graph(self, config: dict):
+        config_path = config.get("_config_path")
+        self.root_module_location = os.path.join(config_path, config.get("rootFolder"))
+        self.target_project_base_location = config_path
+
+        sys.path.insert(0, config_path)
+        sys.path.insert(1, self.root_module_location)
+
+        bt_module_list: list[BTModule] = []
+
+        # Read all the python files within the project
+        file_list = self._get_files_recursive(self.root_module_location)
+
+        # Create modules and add them to module list (No relations between them yet)
+        for file in file_list:
+            try:
+                if not file.endswith("__init__.py"):
+                    continue
+                bt_module = BTModule(file, self.am)
+                bt_module.add_files()
+                bt_module_list.append(bt_module)
+            except Exception as e:
+                print(e)
+                continue
+
+        # Add relations between the modules (parent and child nodes)
+        for module in bt_module_list:
+            for parent_module in bt_module_list:
+                if module == parent_module:
+                    continue
+                if parent_module.path == os.path.dirname(module.path):
+                    parent_module.child_module.append(module)
+                    module.parent_module = parent_module
+
+        # Find the root node
+        self.root_module = next(
+            filter(lambda e: e.parent_module is None, bt_module_list)
+        )
+        self.base_module = self.root_module
+
+        # Add dependencies between all the files
+        btf_map = self.get_all_bt_files_map()
+
+        for bt_file in btf_map.values():
+            imported_modules = get_imported_modules(
+                bt_file.ast, self.target_project_base_location, self.am
+            )
+            bt_file >> [
+                btf_map[module.file]
+                for module in imported_modules
+                if module.file in btf_map
+            ]
+
+        sys.path = sys.path[2:]
+        astroid.manager.AstroidManager().clear_cache()
+        self.am.clear_cache()
+
+    def get_bt_file(self, path: str) -> BTFile:
+        file_path = self.am.ast_from_module_name(path).file
+        bt_file = self.get_all_bt_files_map()[file_path]
+        return bt_file
+
+    def get_bt_module(self, path: str) -> BTModule:
+        path_list = path.split(".")[1:]
+        current_module = self.root_module
+        while path_list:
+            current_module = next(
+                filter(
+                    lambda e: e.name == path_list[0],
+                    current_module.child_module,
+                )
+            )
+            path_list.pop(0)
+        return current_module
+
+    def change_scope(self, path: str):
+        self.root_module = self.get_bt_module(path)
+
+    def get_all_bt_files_map(self) -> dict[str, BTFile]:
+        return {btf.file: btf for btf in self.root_module.get_files_recursive()}
+
+    def get_all_bt_modules_map(self) -> dict[str, BTModule]:
+        return {btm.path: btm for btm in self.root_module.get_submodules_recursive()}
+
+    def _get_files_recursive(self, path: str) -> list[str]:
+        file_list = []
+        t = list(os.walk(path))
+        for root, _, files in t:
+            for file in files:
+                file_list.append(os.path.join(root, file))
+
+        return file_list
+