mvn-tree-visualizer 1.0.1__py3-none-any.whl → 1.0.3b1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mvn_tree_visualizer/__main__.py +2 -69
- mvn_tree_visualizer/cli.py +71 -0
- mvn_tree_visualizer/diagram.py +73 -73
- {mvn_tree_visualizer-1.0.1.dist-info → mvn_tree_visualizer-1.0.3b1.dist-info}/METADATA +12 -2
- mvn_tree_visualizer-1.0.3b1.dist-info/RECORD +10 -0
- mvn_tree_visualizer-1.0.3b1.dist-info/entry_points.txt +2 -0
- mvn_tree_visualizer-1.0.3b1.dist-info/licenses/LICENSE +21 -0
- mvn_tree_visualizer-1.0.1.dist-info/RECORD +0 -7
- {mvn_tree_visualizer-1.0.1.dist-info → mvn_tree_visualizer-1.0.3b1.dist-info}/WHEEL +0 -0
- {mvn_tree_visualizer-1.0.1.dist-info → mvn_tree_visualizer-1.0.3b1.dist-info}/top_level.txt +0 -0
mvn_tree_visualizer/__main__.py
CHANGED
|
@@ -1,71 +1,4 @@
|
|
|
1
|
-
import
|
|
2
|
-
from pathlib import Path
|
|
3
|
-
|
|
4
|
-
from .diagram import create_diagram
|
|
5
|
-
from .get_dependencies_in_one_file import merge_files
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
def main():
|
|
9
|
-
pass
|
|
10
|
-
|
|
1
|
+
from .cli import cli
|
|
11
2
|
|
|
12
3
|
if __name__ == "__main__":
|
|
13
|
-
|
|
14
|
-
prog="mvn-tree-visualizer",
|
|
15
|
-
description="Generate a dependency diagram from a file.",
|
|
16
|
-
)
|
|
17
|
-
parser.add_argument(
|
|
18
|
-
"directory",
|
|
19
|
-
type=str,
|
|
20
|
-
nargs="?",
|
|
21
|
-
default=".",
|
|
22
|
-
help="The directory to scan for the Maven dependency file(s). Default is the current directory.",
|
|
23
|
-
)
|
|
24
|
-
|
|
25
|
-
parser.add_argument(
|
|
26
|
-
"-o",
|
|
27
|
-
"--output",
|
|
28
|
-
type=str,
|
|
29
|
-
default="diagram.html",
|
|
30
|
-
help="The output file for the generated diagram. Default is 'diagram.html'.",
|
|
31
|
-
)
|
|
32
|
-
|
|
33
|
-
parser.add_argument(
|
|
34
|
-
"-f",
|
|
35
|
-
"--filename",
|
|
36
|
-
type=str,
|
|
37
|
-
default="maven_dependency_file",
|
|
38
|
-
help="The name of the file to read the Maven dependencies from. Default is 'maven_dependency_file'.",
|
|
39
|
-
)
|
|
40
|
-
parser.add_argument(
|
|
41
|
-
"--keep-tree",
|
|
42
|
-
type=bool,
|
|
43
|
-
default=False,
|
|
44
|
-
help="Keep the dependency tree file after generating the diagram. Default is False.",
|
|
45
|
-
)
|
|
46
|
-
|
|
47
|
-
args = parser.parse_args()
|
|
48
|
-
directory: str = args.directory
|
|
49
|
-
output_file: str = args.output
|
|
50
|
-
filename: str = args.filename
|
|
51
|
-
keep_tree: bool = args.keep_tree
|
|
52
|
-
|
|
53
|
-
dir_to_create_files = Path(output_file).parent
|
|
54
|
-
|
|
55
|
-
dir_to_create_intermediate_files = Path(dir_to_create_files)
|
|
56
|
-
|
|
57
|
-
merge_files(
|
|
58
|
-
output_file=dir_to_create_intermediate_files / "dependency_tree.txt",
|
|
59
|
-
root_dir=directory,
|
|
60
|
-
target_filename=filename,
|
|
61
|
-
)
|
|
62
|
-
|
|
63
|
-
create_diagram(
|
|
64
|
-
keep_tree=keep_tree,
|
|
65
|
-
intermediate_filename="dependency_tree.txt",
|
|
66
|
-
output_filename=output_file,
|
|
67
|
-
)
|
|
68
|
-
|
|
69
|
-
print(f"Diagram generated and saved to {output_file}")
|
|
70
|
-
print("You can open it in your browser to view the dependency tree.")
|
|
71
|
-
print("Thank you for using mvn-tree-visualizer!")
|
|
4
|
+
cli()
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import argparse
|
|
2
|
+
from pathlib import Path
|
|
3
|
+
|
|
4
|
+
from .diagram import create_diagram
|
|
5
|
+
from .get_dependencies_in_one_file import merge_files
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def cli():
|
|
9
|
+
parser = argparse.ArgumentParser(
|
|
10
|
+
prog="mvn-tree-visualizer",
|
|
11
|
+
description="Generate a dependency diagram from a file.",
|
|
12
|
+
)
|
|
13
|
+
parser.add_argument(
|
|
14
|
+
"directory",
|
|
15
|
+
type=str,
|
|
16
|
+
nargs="?",
|
|
17
|
+
default=".",
|
|
18
|
+
help="The directory to scan for the Maven dependency file(s). Default is the current directory.",
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
parser.add_argument(
|
|
22
|
+
"-o",
|
|
23
|
+
"--output",
|
|
24
|
+
type=str,
|
|
25
|
+
default="diagram.html",
|
|
26
|
+
help="The output file for the generated diagram. Default is 'diagram.html'.",
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
parser.add_argument(
|
|
30
|
+
"-f",
|
|
31
|
+
"--filename",
|
|
32
|
+
type=str,
|
|
33
|
+
default="maven_dependency_file",
|
|
34
|
+
help="The name of the file to read the Maven dependencies from. Default is 'maven_dependency_file'.",
|
|
35
|
+
)
|
|
36
|
+
parser.add_argument(
|
|
37
|
+
"--keep-tree",
|
|
38
|
+
type=bool,
|
|
39
|
+
default=False,
|
|
40
|
+
help="Keep the dependency tree file after generating the diagram. Default is False.",
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
args = parser.parse_args()
|
|
44
|
+
directory: str = args.directory
|
|
45
|
+
output_file: str = args.output
|
|
46
|
+
filename: str = args.filename
|
|
47
|
+
keep_tree: bool = args.keep_tree
|
|
48
|
+
|
|
49
|
+
dir_to_create_files = Path(output_file).parent
|
|
50
|
+
|
|
51
|
+
dir_to_create_intermediate_files = Path(dir_to_create_files)
|
|
52
|
+
|
|
53
|
+
merge_files(
|
|
54
|
+
output_file=dir_to_create_intermediate_files / "dependency_tree.txt",
|
|
55
|
+
root_dir=directory,
|
|
56
|
+
target_filename=filename,
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
create_diagram(
|
|
60
|
+
keep_tree=keep_tree,
|
|
61
|
+
intermediate_filename="dependency_tree.txt",
|
|
62
|
+
output_filename=output_file,
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
print(f"Diagram generated and saved to {output_file}")
|
|
66
|
+
print("You can open it in your browser to view the dependency tree.")
|
|
67
|
+
print("Thank you for using mvn-tree-visualizer!")
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
if __name__ == "__main__":
|
|
71
|
+
cli()
|
mvn_tree_visualizer/diagram.py
CHANGED
|
@@ -1,73 +1,73 @@
|
|
|
1
|
-
from pathlib import Path
|
|
2
|
-
|
|
3
|
-
from jinja2 import Environment, FileSystemLoader
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
def _convert_to_mermaid(dependency_tree: str) -> str:
|
|
7
|
-
# generate a `graph LR` format for Mermaid
|
|
8
|
-
lines = dependency_tree.strip().split("\n")
|
|
9
|
-
mermaid_lines = set()
|
|
10
|
-
|
|
11
|
-
previous_dependency = []
|
|
12
|
-
|
|
13
|
-
for line in lines:
|
|
14
|
-
if not line or line.startswith("[INFO]"):
|
|
15
|
-
continue
|
|
16
|
-
parts = line.split(":")
|
|
17
|
-
|
|
18
|
-
if len(parts) < 3:
|
|
19
|
-
continue
|
|
20
|
-
|
|
21
|
-
if len(parts) == 4:
|
|
22
|
-
group_id, artifact_id, app, version = parts
|
|
23
|
-
mermaid_lines.add(f"\t{artifact_id};")
|
|
24
|
-
|
|
25
|
-
if previous_dependency: # Re initialize the list if it wasn't empty
|
|
26
|
-
previous_dependency = []
|
|
27
|
-
|
|
28
|
-
previous_dependency.append((artifact_id, 0)) # The second element is the depth
|
|
29
|
-
else:
|
|
30
|
-
depth = len(parts[0].split(" ")) - 1
|
|
31
|
-
|
|
32
|
-
if len(parts) == 6:
|
|
33
|
-
dirty_group_id, artifact_id, app, ejb_client, version, dependency = parts
|
|
34
|
-
else:
|
|
35
|
-
dirty_group_id, artifact_id, app, version, dependency = parts
|
|
36
|
-
|
|
37
|
-
if previous_dependency[-1][1] < depth:
|
|
38
|
-
mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
|
|
39
|
-
previous_dependency.append((artifact_id, depth))
|
|
40
|
-
else:
|
|
41
|
-
# remove all dependencies that are deeper or equal to the current depth
|
|
42
|
-
while previous_dependency and previous_dependency[-1][1] >= depth:
|
|
43
|
-
previous_dependency.pop()
|
|
44
|
-
|
|
45
|
-
mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
|
|
46
|
-
previous_dependency.append((artifact_id, depth))
|
|
47
|
-
|
|
48
|
-
mermaid_diagram = f"graph LR\n{'\n'.join(sorted(mermaid_lines))}"
|
|
49
|
-
return mermaid_diagram
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
def create_diagram(keep_tree: bool = False, intermediate_filename: str = "dependency_tree.txt", output_filename: str = "diagram.html"):
|
|
53
|
-
with open(intermediate_filename, "r") as file:
|
|
54
|
-
dependency_tree = file.read()
|
|
55
|
-
|
|
56
|
-
mermaid_diagram = _convert_to_mermaid(dependency_tree)
|
|
57
|
-
|
|
58
|
-
env = Environment(loader=FileSystemLoader("./src/mvn_tree_visualizer"))
|
|
59
|
-
template = env.get_template("dependency_diagram_template.j2")
|
|
60
|
-
rendered = template.render(diagram_definition=mermaid_diagram)
|
|
61
|
-
|
|
62
|
-
parent_dir = Path(output_filename).parent
|
|
63
|
-
|
|
64
|
-
if not parent_dir.exists():
|
|
65
|
-
parent_dir.mkdir(parents=True, exist_ok=True)
|
|
66
|
-
|
|
67
|
-
with open(output_filename, "w") as f:
|
|
68
|
-
f.write(rendered)
|
|
69
|
-
|
|
70
|
-
if not keep_tree:
|
|
71
|
-
import os
|
|
72
|
-
|
|
73
|
-
os.remove(intermediate_filename)
|
|
1
|
+
from pathlib import Path
|
|
2
|
+
|
|
3
|
+
from jinja2 import Environment, FileSystemLoader
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def _convert_to_mermaid(dependency_tree: str) -> str:
|
|
7
|
+
# generate a `graph LR` format for Mermaid
|
|
8
|
+
lines = dependency_tree.strip().split("\n")
|
|
9
|
+
mermaid_lines = set()
|
|
10
|
+
|
|
11
|
+
previous_dependency = []
|
|
12
|
+
|
|
13
|
+
for line in lines:
|
|
14
|
+
if not line or line.startswith("[INFO]"):
|
|
15
|
+
continue
|
|
16
|
+
parts = line.split(":")
|
|
17
|
+
|
|
18
|
+
if len(parts) < 3:
|
|
19
|
+
continue
|
|
20
|
+
|
|
21
|
+
if len(parts) == 4:
|
|
22
|
+
group_id, artifact_id, app, version = parts
|
|
23
|
+
mermaid_lines.add(f"\t{artifact_id};")
|
|
24
|
+
|
|
25
|
+
if previous_dependency: # Re initialize the list if it wasn't empty
|
|
26
|
+
previous_dependency = []
|
|
27
|
+
|
|
28
|
+
previous_dependency.append((artifact_id, 0)) # The second element is the depth
|
|
29
|
+
else:
|
|
30
|
+
depth = len(parts[0].split(" ")) - 1
|
|
31
|
+
|
|
32
|
+
if len(parts) == 6:
|
|
33
|
+
dirty_group_id, artifact_id, app, ejb_client, version, dependency = parts
|
|
34
|
+
else:
|
|
35
|
+
dirty_group_id, artifact_id, app, version, dependency = parts
|
|
36
|
+
|
|
37
|
+
if previous_dependency[-1][1] < depth:
|
|
38
|
+
mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
|
|
39
|
+
previous_dependency.append((artifact_id, depth))
|
|
40
|
+
else:
|
|
41
|
+
# remove all dependencies that are deeper or equal to the current depth
|
|
42
|
+
while previous_dependency and previous_dependency[-1][1] >= depth:
|
|
43
|
+
previous_dependency.pop()
|
|
44
|
+
|
|
45
|
+
mermaid_lines.add(f"\t{previous_dependency[-1][0]} --> {artifact_id};")
|
|
46
|
+
previous_dependency.append((artifact_id, depth))
|
|
47
|
+
|
|
48
|
+
mermaid_diagram = f"graph LR\n{'\n'.join(sorted(mermaid_lines))}"
|
|
49
|
+
return mermaid_diagram
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def create_diagram(keep_tree: bool = False, intermediate_filename: str = "dependency_tree.txt", output_filename: str = "diagram.html"):
|
|
53
|
+
with open(intermediate_filename, "r") as file:
|
|
54
|
+
dependency_tree = file.read()
|
|
55
|
+
|
|
56
|
+
mermaid_diagram = _convert_to_mermaid(dependency_tree)
|
|
57
|
+
|
|
58
|
+
env = Environment(loader=FileSystemLoader("./src/mvn_tree_visualizer"))
|
|
59
|
+
template = env.get_template("dependency_diagram_template.j2")
|
|
60
|
+
rendered = template.render(diagram_definition=mermaid_diagram)
|
|
61
|
+
|
|
62
|
+
parent_dir = Path(output_filename).parent
|
|
63
|
+
|
|
64
|
+
if not parent_dir.exists():
|
|
65
|
+
parent_dir.mkdir(parents=True, exist_ok=True)
|
|
66
|
+
|
|
67
|
+
with open(output_filename, "w") as f:
|
|
68
|
+
f.write(rendered)
|
|
69
|
+
|
|
70
|
+
if not keep_tree:
|
|
71
|
+
import os
|
|
72
|
+
|
|
73
|
+
os.remove(intermediate_filename)
|
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mvn-tree-visualizer
|
|
3
|
-
Version: 1.0.
|
|
3
|
+
Version: 1.0.3b1
|
|
4
4
|
Summary: A simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
|
|
5
5
|
Author-email: Iraklis Konsoulas <dyka3773@gmail.com>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: source, https://github.com/dyka3773/mvn-tree-visualizer
|
|
8
|
+
Keywords: maven,dependency,visualization,tree,cli,command-line,tool,graph,mermaid
|
|
9
|
+
Classifier: Development Status :: 4 - Beta
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
6
14
|
Requires-Python: >=3.13
|
|
7
15
|
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: LICENSE
|
|
8
17
|
Requires-Dist: jinja2>=3.1.6
|
|
18
|
+
Dynamic: license-file
|
|
9
19
|
|
|
10
20
|
# mvn-tree-visualizer
|
|
11
21
|
|
|
@@ -19,7 +29,7 @@ This project provides a simple command line tool to visualize the dependency tre
|
|
|
19
29
|
> Feel free to add other options to the command as needed. eg `-Dincludes="org.example"`
|
|
20
30
|
2. Use the `mvn-tree-visualizer` command to visualize the dependency tree:
|
|
21
31
|
```bash
|
|
22
|
-
|
|
32
|
+
python -m mvn_tree_visualizer --filename "maven_dependency_file" --output "diagram.html"
|
|
23
33
|
```
|
|
24
34
|
3. Open the generated `diagram.html` file in your web browser to view the dependency tree.
|
|
25
35
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
mvn_tree_visualizer/__main__.py,sha256=CE0SkifsGtLofFUdPozg-CvvkqrCmZlOpjap1nBnVnM,63
|
|
2
|
+
mvn_tree_visualizer/cli.py,sha256=sMl1yeCQGwWswiC5xVEOdy1nXhF9Vx5DnoqfHuq02_U,2036
|
|
3
|
+
mvn_tree_visualizer/diagram.py,sha256=bxZC7Hqr06KIEYYFavKKGo1JL8l2uo0TC1aTgjcpbGk,2640
|
|
4
|
+
mvn_tree_visualizer/get_dependencies_in_one_file.py,sha256=d0ldXC0sYvDKLXozD0JgHsMcID_gN4xjeCUdk5TCiV4,515
|
|
5
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/licenses/LICENSE,sha256=c_8ezHwcOG8McIzdj7ZPgkqN1RuUMfP0hlmd6gX4gR0,1096
|
|
6
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/METADATA,sha256=-XUuZc97WtMqrVH_Shi1VICPnOBNt74g3F5kVlh7U3Q,2036
|
|
7
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
8
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/entry_points.txt,sha256=Mu3QZhrlvbYuCxqmluVGi2efgKjkQY6T8Opf-vdb7hU,68
|
|
9
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/top_level.txt,sha256=HnFdJDMoJlvQhMTolib_U5UawIdRfkNk8andYnM5lMk,20
|
|
10
|
+
mvn_tree_visualizer-1.0.3b1.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Hercules Konsoulas
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
mvn_tree_visualizer/__main__.py,sha256=DiYSKezcZRs-AKWTlv7LyfDs7znx9SEbvLXg82swQSM,2036
|
|
2
|
-
mvn_tree_visualizer/diagram.py,sha256=4zElrTDnoh1GWJkxmb50O30G-0CNz6hiR1faFr77VAQ,2567
|
|
3
|
-
mvn_tree_visualizer/get_dependencies_in_one_file.py,sha256=d0ldXC0sYvDKLXozD0JgHsMcID_gN4xjeCUdk5TCiV4,515
|
|
4
|
-
mvn_tree_visualizer-1.0.1.dist-info/METADATA,sha256=frZ836AGAyfauaBQDn9HYP-oDBxFx2F5Cfz4-7ZtGvY,1552
|
|
5
|
-
mvn_tree_visualizer-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
-
mvn_tree_visualizer-1.0.1.dist-info/top_level.txt,sha256=HnFdJDMoJlvQhMTolib_U5UawIdRfkNk8andYnM5lMk,20
|
|
7
|
-
mvn_tree_visualizer-1.0.1.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|