mvn-tree-visualizer 1.0.3b1__py3-none-any.whl → 1.0.3b3__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.
Potentially problematic release.
This version of mvn-tree-visualizer might be problematic. Click here for more details.
- dependency_diagram_template.j2 +61 -0
- {mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/METADATA +41 -42
- mvn_tree_visualizer-1.0.3b3.dist-info/RECORD +6 -0
- {mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/WHEEL +1 -2
- mvn_tree_visualizer/__main__.py +0 -4
- mvn_tree_visualizer/cli.py +0 -71
- mvn_tree_visualizer/diagram.py +0 -73
- mvn_tree_visualizer/get_dependencies_in_one_file.py +0 -11
- mvn_tree_visualizer-1.0.3b1.dist-info/RECORD +0 -10
- mvn_tree_visualizer-1.0.3b1.dist-info/top_level.txt +0 -1
- {mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/entry_points.txt +0 -0
- {mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
<html></html>
|
|
2
|
+
<head>
|
|
3
|
+
<style type="text/css">
|
|
4
|
+
#mySvgId {
|
|
5
|
+
height: 90%;
|
|
6
|
+
width: 90%;
|
|
7
|
+
}
|
|
8
|
+
</style>
|
|
9
|
+
<title>Dependency Diagram</title>
|
|
10
|
+
</head>
|
|
11
|
+
<body>
|
|
12
|
+
<div id="graphDiv"></div>
|
|
13
|
+
<button id="downloadButton">Download SVG</button>
|
|
14
|
+
<script src="https://cdn.jsdelivr.net/npm/svg-pan-zoom@3.5.0/dist/svg-pan-zoom.min.js"></script>
|
|
15
|
+
<script type="module">
|
|
16
|
+
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10.9.0/dist/mermaid.esm.min.mjs';
|
|
17
|
+
mermaid.initialize({
|
|
18
|
+
startOnLoad:true,
|
|
19
|
+
sequence:{
|
|
20
|
+
useMaxWidth:false
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
const drawDiagram = async function () {
|
|
25
|
+
const element = document.querySelector('#graphDiv');
|
|
26
|
+
const graphDefinition = `
|
|
27
|
+
{{diagram_definition}}
|
|
28
|
+
`;
|
|
29
|
+
const { svg } = await mermaid.render('mySvgId', graphDefinition);
|
|
30
|
+
element.innerHTML = svg.replace(/[ ]*max-width:[ 0-9\.]*px;/i , '');
|
|
31
|
+
var panZoomTiger = svgPanZoom('#mySvgId', {
|
|
32
|
+
zoomEnabled: true,
|
|
33
|
+
controlIconsEnabled: true,
|
|
34
|
+
fit: true,
|
|
35
|
+
center: true
|
|
36
|
+
})
|
|
37
|
+
};
|
|
38
|
+
await drawDiagram();
|
|
39
|
+
|
|
40
|
+
// Add event listener to the download button to download the SVG without the pan & zoom buttons
|
|
41
|
+
document.getElementById('downloadButton').addEventListener('click', function() {
|
|
42
|
+
const svg = document.querySelector('#mySvgId');
|
|
43
|
+
let svgData = new XMLSerializer().serializeToString(svg);
|
|
44
|
+
|
|
45
|
+
// To remove the pan & zoom buttons of the diagram, any element whose class contains the string 'svg-pan-zoom-*' should be removed
|
|
46
|
+
svgData = svgData.replace(/<g\b[^>]*\bclass="svg-pan-zoom-.*?".*?>.*?<\/g>/g, '');
|
|
47
|
+
// The above leaves out a closing </g> tag before the final </svg> tag, so we need to remove it
|
|
48
|
+
svgData = svgData.replace(/<\/g><\/svg>/, '</svg>');
|
|
49
|
+
|
|
50
|
+
const svgBlob = new Blob([svgData], {type: 'image/svg+xml;charset=utf-8'});
|
|
51
|
+
const svgUrl = URL.createObjectURL(svgBlob);
|
|
52
|
+
const downloadLink = document.createElement('a');
|
|
53
|
+
downloadLink.href = svgUrl;
|
|
54
|
+
downloadLink.download = 'diagram.svg';
|
|
55
|
+
document.body.appendChild(downloadLink);
|
|
56
|
+
downloadLink.click();
|
|
57
|
+
document.body.removeChild(downloadLink);
|
|
58
|
+
});
|
|
59
|
+
</script>
|
|
60
|
+
</body>
|
|
61
|
+
</html>
|
|
@@ -1,42 +1,41 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: mvn-tree-visualizer
|
|
3
|
-
Version: 1.0.
|
|
4
|
-
Summary: A simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
Classifier:
|
|
11
|
-
Classifier:
|
|
12
|
-
Classifier: Programming Language :: Python :: 3
|
|
13
|
-
Classifier:
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
- `--
|
|
38
|
-
- `--
|
|
39
|
-
- `--
|
|
40
|
-
- `--
|
|
41
|
-
|
|
42
|
-
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mvn-tree-visualizer
|
|
3
|
+
Version: 1.0.3b3
|
|
4
|
+
Summary: A simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
|
|
5
|
+
Project-URL: source, https://github.com/dyka3773/mvn-tree-visualizer
|
|
6
|
+
Author-email: Iraklis Konsoulas <dyka3773@gmail.com>
|
|
7
|
+
License-Expression: MIT
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Keywords: cli,command-line,dependency,graph,maven,mermaid,tool,tree,visualization
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
15
|
+
Requires-Python: >=3.13
|
|
16
|
+
Requires-Dist: jinja2>=3.1.6
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
|
|
19
|
+
# mvn-tree-visualizer
|
|
20
|
+
|
|
21
|
+
This project provides a simple command line tool to visualize the dependency tree of a Maven project in a graphical format.
|
|
22
|
+
|
|
23
|
+
## How to Use
|
|
24
|
+
1. Run the following command in your terminal to generate the dependency tree and save it to a file:
|
|
25
|
+
```bash
|
|
26
|
+
mvn dependency:tree -DoutputFile=maven_dependency_file -DappendOutput=true
|
|
27
|
+
```
|
|
28
|
+
> Feel free to add other options to the command as needed. eg `-Dincludes="org.example"`
|
|
29
|
+
2. Use the `mvn-tree-visualizer` command to visualize the dependency tree:
|
|
30
|
+
```bash
|
|
31
|
+
python -m mvn_tree_visualizer --filename "maven_dependency_file" --output "diagram.html"
|
|
32
|
+
```
|
|
33
|
+
3. Open the generated `diagram.html` file in your web browser to view the dependency tree.
|
|
34
|
+
|
|
35
|
+
## Options
|
|
36
|
+
- `--filename`: The name of the file containing the Maven dependency tree. Default is `maven_dependency_file`.
|
|
37
|
+
- `--output`: The name of the output HTML file. Default is `diagram.html`.
|
|
38
|
+
- `--directory`: The directory to scan for the Maven dependency file(s). Default is the current directory.
|
|
39
|
+
- `--keep-tree`: Keep the tree structure file when processing is complete in the same directory as the output file. Default is false.
|
|
40
|
+
- `--help`: Show help message and exit.
|
|
41
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
dependency_diagram_template.j2,sha256=BEE4OfnnhiFk7Bvz_5mmNcQTbB1gKJanusbArDt1yco,2535
|
|
2
|
+
mvn_tree_visualizer-1.0.3b3.dist-info/METADATA,sha256=tZZCDCmiHdi9DnQmy28-cySriPmHiRoAgSFquPkZu-c,1972
|
|
3
|
+
mvn_tree_visualizer-1.0.3b3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
4
|
+
mvn_tree_visualizer-1.0.3b3.dist-info/entry_points.txt,sha256=Mu3QZhrlvbYuCxqmluVGi2efgKjkQY6T8Opf-vdb7hU,68
|
|
5
|
+
mvn_tree_visualizer-1.0.3b3.dist-info/licenses/LICENSE,sha256=c_8ezHwcOG8McIzdj7ZPgkqN1RuUMfP0hlmd6gX4gR0,1096
|
|
6
|
+
mvn_tree_visualizer-1.0.3b3.dist-info/RECORD,,
|
mvn_tree_visualizer/__main__.py
DELETED
mvn_tree_visualizer/cli.py
DELETED
|
@@ -1,71 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
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 +0,0 @@
|
|
|
1
|
-
import os
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
def merge_files(output_file: str, root_dir: str = ".", target_filename: str = "maven_dependency_file"):
|
|
5
|
-
with open(output_file, "w", encoding="utf-8") as outfile:
|
|
6
|
-
for dirpath, _, filenames in os.walk(root_dir):
|
|
7
|
-
for fname in filenames:
|
|
8
|
-
if fname == target_filename:
|
|
9
|
-
file_path = os.path.join(dirpath, fname)
|
|
10
|
-
with open(file_path, "r", encoding="utf-8") as infile:
|
|
11
|
-
outfile.write(infile.read())
|
|
@@ -1,10 +0,0 @@
|
|
|
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,,
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
mvn_tree_visualizer
|
{mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/entry_points.txt
RENAMED
|
File without changes
|
{mvn_tree_visualizer-1.0.3b1.dist-info → mvn_tree_visualizer-1.0.3b3.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|