mvn-tree-visualizer 1.0.1__py3-none-any.whl

mvn_tree_visualizer/__main__.py

@@ -0,0 +1,71 @@
+import argparse
+from pathlib import Path
+
+from .diagram import create_diagram
+from .get_dependencies_in_one_file import merge_files
+
+
+def main():
+    pass
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        prog="mvn-tree-visualizer",
+        description="Generate a dependency diagram from a file.",
+    )
+    parser.add_argument(
+        "directory",
+        type=str,
+        nargs="?",
+        default=".",
+        help="The directory to scan for the Maven dependency file(s). Default is the current directory.",
+    )
+
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=str,
+        default="diagram.html",
+        help="The output file for the generated diagram. Default is 'diagram.html'.",
+    )
+
+    parser.add_argument(
+        "-f",
+        "--filename",
+        type=str,
+        default="maven_dependency_file",
+        help="The name of the file to read the Maven dependencies from. Default is 'maven_dependency_file'.",
+    )
+    parser.add_argument(
+        "--keep-tree",
+        type=bool,
+        default=False,
+        help="Keep the dependency tree file after generating the diagram. Default is False.",
+    )
+
+    args = parser.parse_args()
+    directory: str = args.directory
+    output_file: str = args.output
+    filename: str = args.filename
+    keep_tree: bool = args.keep_tree
+
+    dir_to_create_files = Path(output_file).parent
+
+    dir_to_create_intermediate_files = Path(dir_to_create_files)
+
+    merge_files(
+        output_file=dir_to_create_intermediate_files / "dependency_tree.txt",
+        root_dir=directory,
+        target_filename=filename,
+    )
+
+    create_diagram(
+        keep_tree=keep_tree,
+        intermediate_filename="dependency_tree.txt",
+        output_filename=output_file,
+    )
+
+    print(f"Diagram generated and saved to {output_file}")
+    print("You can open it in your browser to view the dependency tree.")
+    print("Thank you for using mvn-tree-visualizer!")

mvn_tree_visualizer/diagram.py

@@ -0,0 +1,73 @@
+from pathlib import Path
+
+from jinja2 import Environment, FileSystemLoader
+
+
+def _convert_to_mermaid(dependency_tree: str) -> str:
+    # generate a `graph LR` format for Mermaid
+    lines = dependency_tree.strip().split("\n")
+    mermaid_lines = set()
+
+    previous_dependency = []
+
+    for line in lines:
+        if not line or line.startswith("[INFO]"):
+            continue
+        parts = line.split(":")
+
+        if len(parts) < 3:
+            continue
+
+        if len(parts) == 4:
+            group_id, artifact_id, app, version = parts
+            mermaid_lines.add(f"\t{artifact_id};")
+
+            if previous_dependency:  # Re initialize the list if it wasn't empty
+                previous_dependency = []
+
+            previous_dependency.append((artifact_id, 0))  # The second element is the depth
+        else:
+            depth = len(parts[0].split(" ")) - 1
+
+            if len(parts) == 6:
+                dirty_group_id, artifact_id, app, ejb_client, version, dependency = parts
+            else:
+                dirty_group_id, artifact_id, app, version, dependency = parts
+
+            if previous_dependency[-1][1] < depth:
+                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
+                previous_dependency.append((artifact_id, depth))
+            else:
+                # remove all dependencies that are deeper or equal to the current depth
+                while previous_dependency and previous_dependency[-1][1] >= depth:
+                    previous_dependency.pop()
+
+                mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
+                previous_dependency.append((artifact_id, depth))
+
+    mermaid_diagram = f"graph LR\n{'\n'.join(sorted(mermaid_lines))}"
+    return mermaid_diagram
+
+
+def create_diagram(keep_tree: bool = False, intermediate_filename: str = "dependency_tree.txt", output_filename: str = "diagram.html"):
+    with open(intermediate_filename, "r") as file:
+        dependency_tree = file.read()
+
+    mermaid_diagram = _convert_to_mermaid(dependency_tree)
+
+    env = Environment(loader=FileSystemLoader("./src/mvn_tree_visualizer"))
+    template = env.get_template("dependency_diagram_template.j2")
+    rendered = template.render(diagram_definition=mermaid_diagram)
+
+    parent_dir = Path(output_filename).parent
+
+    if not parent_dir.exists():
+        parent_dir.mkdir(parents=True, exist_ok=True)
+
+    with open(output_filename, "w") as f:
+        f.write(rendered)
+
+    if not keep_tree:
+        import os
+
+        os.remove(intermediate_filename)

mvn_tree_visualizer/get_dependencies_in_one_file.py

@@ -0,0 +1,11 @@
+import os
+
+
+def merge_files(output_file: str, root_dir: str = ".", target_filename: str = "maven_dependency_file"):
+    with open(output_file, "w", encoding="utf-8") as outfile:
+        for dirpath, _, filenames in os.walk(root_dir):
+            for fname in filenames:
+                if fname == target_filename:
+                    file_path = os.path.join(dirpath, fname)
+                    with open(file_path, "r", encoding="utf-8") as infile:
+                        outfile.write(infile.read())

mvn_tree_visualizer-1.0.1.dist-info/METADATA

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: mvn-tree-visualizer
+Version: 1.0.1
+Summary: A simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
+Author-email: Iraklis Konsoulas <dyka3773@gmail.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: jinja2>=3.1.6
+
+# mvn-tree-visualizer
+
+This project provides a simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
+
+## How to Use
+1. Run the following command in your terminal to generate the dependency tree and save it to a file:
+   ```bash
+   mvn dependency:tree -DoutputFile=maven_dependency_file -DappendOutput=true
+   ```
+   > Feel free to add other options to the command as needed. eg `-Dincludes="org.example"`
+2. Use the `mvn-tree-visualizer` command to visualize the dependency tree:
+   ```bash
+    mvn-tree-visualizer --filename "maven_dependency_file" --output "diagram.html"
+    ```
+3. Open the generated `diagram.html` file in your web browser to view the dependency tree.
+
+## Options
+- `--filename`: The name of the file containing the Maven dependency tree. Default is `maven_dependency_file`.
+- `--output`: The name of the output HTML file. Default is `diagram.html`.
+- `--directory`: The directory to scan for the Maven dependency file(s). Default is the current directory.
+- `--keep-tree`: Keep the tree structure file when processing is complete in the same directory as the output file. Default is false.
+- `--help`: Show help message and exit.
+

mvn_tree_visualizer-1.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+mvn_tree_visualizer/__main__.py,sha256=DiYSKezcZRs-AKWTlv7LyfDs7znx9SEbvLXg82swQSM,2036
+mvn_tree_visualizer/diagram.py,sha256=4zElrTDnoh1GWJkxmb50O30G-0CNz6hiR1faFr77VAQ,2567
+mvn_tree_visualizer/get_dependencies_in_one_file.py,sha256=d0ldXC0sYvDKLXozD0JgHsMcID_gN4xjeCUdk5TCiV4,515
+mvn_tree_visualizer-1.0.1.dist-info/METADATA,sha256=frZ836AGAyfauaBQDn9HYP-oDBxFx2F5Cfz4-7ZtGvY,1552
+mvn_tree_visualizer-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mvn_tree_visualizer-1.0.1.dist-info/top_level.txt,sha256=HnFdJDMoJlvQhMTolib_U5UawIdRfkNk8andYnM5lMk,20
+mvn_tree_visualizer-1.0.1.dist-info/RECORD,,

mvn_tree_visualizer-1.0.1.dist-info/WHEEL

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

mvn_tree_visualizer-1.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+mvn_tree_visualizer