mvn-tree-visualizer 1.0.3b3__tar.gz → 1.1.0__tar.gz
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-1.1.0/.github/workflows/publish.yml +26 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/.gitignore +198 -195
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/.python-version +1 -1
- mvn_tree_visualizer-1.1.0/CODE_OF_CONDUCT.md +122 -0
- mvn_tree_visualizer-1.1.0/CONTRIBUTING.md +70 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/LICENSE +21 -21
- mvn_tree_visualizer-1.1.0/PKG-INFO +71 -0
- mvn_tree_visualizer-1.1.0/README.md +53 -0
- mvn_tree_visualizer-1.1.0/ROADMAP.md +34 -0
- mvn_tree_visualizer-1.1.0/issues.md +106 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/pyproject.toml +50 -51
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/ruff.toml +34 -34
- mvn_tree_visualizer-1.0.3b3/dependency_diagram_template.j2 → mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/TEMPLATE.py +61 -61
- mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/__init__.py +0 -0
- mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/__main__.py +4 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/src/mvn_tree_visualizer/cli.py +86 -71
- mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/diagram.py +13 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/src/mvn_tree_visualizer/get_dependencies_in_one_file.py +11 -11
- mvn_tree_visualizer-1.0.3b3/src/mvn_tree_visualizer/diagram.py → mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/outputs/html_output.py +49 -73
- mvn_tree_visualizer-1.1.0/src/mvn_tree_visualizer/outputs/json_output.py +47 -0
- mvn_tree_visualizer-1.1.0/tests/test_html_output.py +85 -0
- mvn_tree_visualizer-1.1.0/tests/test_json_output.py +100 -0
- {mvn_tree_visualizer-1.0.3b3 → mvn_tree_visualizer-1.1.0}/uv.lock +49 -2
- mvn_tree_visualizer-1.0.3b3/PKG-INFO +0 -41
- mvn_tree_visualizer-1.0.3b3/README.md +0 -23
- mvn_tree_visualizer-1.0.3b3/src/mvn_tree_visualizer/__main__.py +0 -4
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ master ]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
deploy:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v4
|
|
12
|
+
- name: Set up Python
|
|
13
|
+
uses: actions/setup-python@v5
|
|
14
|
+
with:
|
|
15
|
+
python-version: '3.x'
|
|
16
|
+
- name: Install dependencies
|
|
17
|
+
run: |
|
|
18
|
+
python -m pip install --upgrade pip
|
|
19
|
+
pip install build twine
|
|
20
|
+
- name: Build package
|
|
21
|
+
run: python -m build
|
|
22
|
+
- name: Publish package
|
|
23
|
+
env:
|
|
24
|
+
TWINE_USERNAME: __token__
|
|
25
|
+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
|
|
26
|
+
run: twine upload dist/*
|
|
@@ -1,195 +1,198 @@
|
|
|
1
|
-
# Byte-compiled / optimized / DLL files
|
|
2
|
-
__pycache__/
|
|
3
|
-
*.py[cod]
|
|
4
|
-
*$py.class
|
|
5
|
-
|
|
6
|
-
# C extensions
|
|
7
|
-
*.so
|
|
8
|
-
|
|
9
|
-
# Distribution / packaging
|
|
10
|
-
.Python
|
|
11
|
-
build/
|
|
12
|
-
develop-eggs/
|
|
13
|
-
dist/
|
|
14
|
-
downloads/
|
|
15
|
-
eggs/
|
|
16
|
-
.eggs/
|
|
17
|
-
lib/
|
|
18
|
-
lib64/
|
|
19
|
-
parts/
|
|
20
|
-
sdist/
|
|
21
|
-
var/
|
|
22
|
-
wheels/
|
|
23
|
-
share/python-wheels/
|
|
24
|
-
*.egg-info/
|
|
25
|
-
.installed.cfg
|
|
26
|
-
*.egg
|
|
27
|
-
MANIFEST
|
|
28
|
-
|
|
29
|
-
# PyInstaller
|
|
30
|
-
# Usually these files are written by a python script from a template
|
|
31
|
-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
-
*.manifest
|
|
33
|
-
*.spec
|
|
34
|
-
|
|
35
|
-
# Installer logs
|
|
36
|
-
pip-log.txt
|
|
37
|
-
pip-delete-this-directory.txt
|
|
38
|
-
|
|
39
|
-
# Unit test / coverage reports
|
|
40
|
-
htmlcov/
|
|
41
|
-
.tox/
|
|
42
|
-
.nox/
|
|
43
|
-
.coverage
|
|
44
|
-
.coverage.*
|
|
45
|
-
.cache
|
|
46
|
-
nosetests.xml
|
|
47
|
-
coverage.xml
|
|
48
|
-
*.cover
|
|
49
|
-
*.py,cover
|
|
50
|
-
.hypothesis/
|
|
51
|
-
.pytest_cache/
|
|
52
|
-
cover/
|
|
53
|
-
|
|
54
|
-
# Translations
|
|
55
|
-
*.mo
|
|
56
|
-
*.pot
|
|
57
|
-
|
|
58
|
-
# Django stuff:
|
|
59
|
-
*.log
|
|
60
|
-
local_settings.py
|
|
61
|
-
db.sqlite3
|
|
62
|
-
db.sqlite3-journal
|
|
63
|
-
|
|
64
|
-
# Flask stuff:
|
|
65
|
-
instance/
|
|
66
|
-
.webassets-cache
|
|
67
|
-
|
|
68
|
-
# Scrapy stuff:
|
|
69
|
-
.scrapy
|
|
70
|
-
|
|
71
|
-
# Sphinx documentation
|
|
72
|
-
docs/_build/
|
|
73
|
-
|
|
74
|
-
# PyBuilder
|
|
75
|
-
.pybuilder/
|
|
76
|
-
target/
|
|
77
|
-
|
|
78
|
-
# Jupyter Notebook
|
|
79
|
-
.ipynb_checkpoints
|
|
80
|
-
|
|
81
|
-
# IPython
|
|
82
|
-
profile_default/
|
|
83
|
-
ipython_config.py
|
|
84
|
-
|
|
85
|
-
# pyenv
|
|
86
|
-
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
-
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
-
# .python-version
|
|
89
|
-
|
|
90
|
-
# pipenv
|
|
91
|
-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
-
# install all needed dependencies.
|
|
95
|
-
#Pipfile.lock
|
|
96
|
-
|
|
97
|
-
# UV
|
|
98
|
-
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
-
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
-
# commonly ignored for libraries.
|
|
101
|
-
#uv.lock
|
|
102
|
-
|
|
103
|
-
# poetry
|
|
104
|
-
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
-
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
-
# commonly ignored for libraries.
|
|
107
|
-
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
-
#poetry.lock
|
|
109
|
-
#poetry.toml
|
|
110
|
-
|
|
111
|
-
# pdm
|
|
112
|
-
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
-
#pdm.lock
|
|
114
|
-
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
115
|
-
# in version control.
|
|
116
|
-
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
117
|
-
.pdm.toml
|
|
118
|
-
.pdm-python
|
|
119
|
-
.pdm-build/
|
|
120
|
-
|
|
121
|
-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
122
|
-
__pypackages__/
|
|
123
|
-
|
|
124
|
-
# Celery stuff
|
|
125
|
-
celerybeat-schedule
|
|
126
|
-
celerybeat.pid
|
|
127
|
-
|
|
128
|
-
# SageMath parsed files
|
|
129
|
-
*.sage.py
|
|
130
|
-
|
|
131
|
-
# Environments
|
|
132
|
-
.env
|
|
133
|
-
.venv
|
|
134
|
-
env/
|
|
135
|
-
venv/
|
|
136
|
-
ENV/
|
|
137
|
-
env.bak/
|
|
138
|
-
venv.bak/
|
|
139
|
-
|
|
140
|
-
# Spyder project settings
|
|
141
|
-
.spyderproject
|
|
142
|
-
.spyproject
|
|
143
|
-
|
|
144
|
-
# Rope project settings
|
|
145
|
-
.ropeproject
|
|
146
|
-
|
|
147
|
-
# mkdocs documentation
|
|
148
|
-
/site
|
|
149
|
-
|
|
150
|
-
# mypy
|
|
151
|
-
.mypy_cache/
|
|
152
|
-
.dmypy.json
|
|
153
|
-
dmypy.json
|
|
154
|
-
|
|
155
|
-
# Pyre type checker
|
|
156
|
-
.pyre/
|
|
157
|
-
|
|
158
|
-
# pytype static type analyzer
|
|
159
|
-
.pytype/
|
|
160
|
-
|
|
161
|
-
# Cython debug symbols
|
|
162
|
-
cython_debug/
|
|
163
|
-
|
|
164
|
-
# PyCharm
|
|
165
|
-
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
166
|
-
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
167
|
-
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
168
|
-
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
169
|
-
#.idea/
|
|
170
|
-
|
|
171
|
-
# Abstra
|
|
172
|
-
# Abstra is an AI-powered process automation framework.
|
|
173
|
-
# Ignore directories containing user credentials, local state, and settings.
|
|
174
|
-
# Learn more at https://abstra.io/docs
|
|
175
|
-
.abstra/
|
|
176
|
-
|
|
177
|
-
# Visual Studio Code
|
|
178
|
-
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
179
|
-
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
180
|
-
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
181
|
-
# you could uncomment the following to ignore the entire vscode folder
|
|
182
|
-
# .vscode/
|
|
183
|
-
|
|
184
|
-
# Ruff stuff:
|
|
185
|
-
.ruff_cache/
|
|
186
|
-
|
|
187
|
-
# PyPI configuration file
|
|
188
|
-
.pypirc
|
|
189
|
-
|
|
190
|
-
# Cursor
|
|
191
|
-
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
192
|
-
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
193
|
-
# refer to https://docs.cursor.com/context/ignore-files
|
|
194
|
-
.cursorignore
|
|
195
|
-
.cursorindexingignore
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
#poetry.lock
|
|
109
|
+
#poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
#pdm.lock
|
|
114
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
115
|
+
# in version control.
|
|
116
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
117
|
+
.pdm.toml
|
|
118
|
+
.pdm-python
|
|
119
|
+
.pdm-build/
|
|
120
|
+
|
|
121
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
122
|
+
__pypackages__/
|
|
123
|
+
|
|
124
|
+
# Celery stuff
|
|
125
|
+
celerybeat-schedule
|
|
126
|
+
celerybeat.pid
|
|
127
|
+
|
|
128
|
+
# SageMath parsed files
|
|
129
|
+
*.sage.py
|
|
130
|
+
|
|
131
|
+
# Environments
|
|
132
|
+
.env
|
|
133
|
+
.venv
|
|
134
|
+
env/
|
|
135
|
+
venv/
|
|
136
|
+
ENV/
|
|
137
|
+
env.bak/
|
|
138
|
+
venv.bak/
|
|
139
|
+
|
|
140
|
+
# Spyder project settings
|
|
141
|
+
.spyderproject
|
|
142
|
+
.spyproject
|
|
143
|
+
|
|
144
|
+
# Rope project settings
|
|
145
|
+
.ropeproject
|
|
146
|
+
|
|
147
|
+
# mkdocs documentation
|
|
148
|
+
/site
|
|
149
|
+
|
|
150
|
+
# mypy
|
|
151
|
+
.mypy_cache/
|
|
152
|
+
.dmypy.json
|
|
153
|
+
dmypy.json
|
|
154
|
+
|
|
155
|
+
# Pyre type checker
|
|
156
|
+
.pyre/
|
|
157
|
+
|
|
158
|
+
# pytype static type analyzer
|
|
159
|
+
.pytype/
|
|
160
|
+
|
|
161
|
+
# Cython debug symbols
|
|
162
|
+
cython_debug/
|
|
163
|
+
|
|
164
|
+
# PyCharm
|
|
165
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
166
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
167
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
168
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
169
|
+
#.idea/
|
|
170
|
+
|
|
171
|
+
# Abstra
|
|
172
|
+
# Abstra is an AI-powered process automation framework.
|
|
173
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
174
|
+
# Learn more at https://abstra.io/docs
|
|
175
|
+
.abstra/
|
|
176
|
+
|
|
177
|
+
# Visual Studio Code
|
|
178
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
179
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
180
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
181
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
182
|
+
# .vscode/
|
|
183
|
+
|
|
184
|
+
# Ruff stuff:
|
|
185
|
+
.ruff_cache/
|
|
186
|
+
|
|
187
|
+
# PyPI configuration file
|
|
188
|
+
.pypirc
|
|
189
|
+
|
|
190
|
+
# Cursor
|
|
191
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
192
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
193
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
194
|
+
.cursorignore
|
|
195
|
+
.cursorindexingignore
|
|
196
|
+
|
|
197
|
+
# Gemini context file
|
|
198
|
+
CONTEXT.md
|
|
@@ -1 +1 @@
|
|
|
1
|
-
3.13
|
|
1
|
+
3.13
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
+
and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that are professional, respectful, and
|
|
13
|
+
considerate of the diverse experiences and perspectives of all participants.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
[INSERT CONTACT METHOD].
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interaction in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
[homepage]: https://www.contributor-covenant.org
|
|
122
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Contributing to mvn-tree-visualizer
|
|
2
|
+
|
|
3
|
+
First off, thank you for considering contributing to `mvn-tree-visualizer`! It's people like you that make open source so great.
|
|
4
|
+
|
|
5
|
+
## Where do I go from here?
|
|
6
|
+
|
|
7
|
+
If you've noticed a bug or have a feature request, [make one](https://github.com/dyka3773/mvn-tree-visualizer/issues/new)! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.
|
|
8
|
+
|
|
9
|
+
### Fork & create a branch
|
|
10
|
+
|
|
11
|
+
If this is something you think you can fix, then [fork `mvn-tree-visualizer`](https://github.com/dyka3773/mvn-tree-visualizer/fork) and create a branch with a descriptive name.
|
|
12
|
+
|
|
13
|
+
A good branch name would be (where issue #123 is the ticket you're working on):
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
git checkout -b 123-add-a-feature
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Get the code
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/your-username/mvn-tree-visualizer.git
|
|
23
|
+
cd mvn-tree-visualizer
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Set up the development environment
|
|
27
|
+
|
|
28
|
+
We use `uv` for dependency management. To set up the development environment, run:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
uv sync --dev
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
This will install all the dependencies needed for development, including the ones for running tests.
|
|
35
|
+
|
|
36
|
+
### Make your changes
|
|
37
|
+
|
|
38
|
+
Make your changes to the code. Make sure to add tests for your changes!
|
|
39
|
+
|
|
40
|
+
### Run the tests
|
|
41
|
+
|
|
42
|
+
To run the tests, run:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
pytest
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Commit and push
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
git commit -m "Your descriptive commit message"
|
|
52
|
+
git push origin 123-add-a-feature
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Create a pull request
|
|
56
|
+
|
|
57
|
+
Go to the GitHub repository and create a pull request.
|
|
58
|
+
|
|
59
|
+
## Style guide
|
|
60
|
+
|
|
61
|
+
We use `ruff` for linting and formatting. Please make sure your code conforms to the style guide by running:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
ruff check .
|
|
65
|
+
ruff format .
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Code of Conduct
|
|
69
|
+
|
|
70
|
+
We have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
|
@@ -1,21 +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
|
+
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.
|