1
2
3
4
5
6
7
8
9
10
11
12
13
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
.. _DEP:
Dependencies
############
.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyTooling
:alt: Libraries.io status for latest release
:height: 22
:target: https://libraries.io/github/pyTooling/pyTooling
.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/pyTooling
:alt: Snyk Vulnerabilities for GitHub Repo
:height: 22
:target: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/pyTooling
+------------------------------------------+------------------------------------------+
| `Libraries.io <https://libraries.io/>`_ | Vulnerabilities Summary |
+==========================================+==========================================+
| |img-pyTooling-lib-status| | |img-pyTooling-vul-status| |
+------------------------------------------+------------------------------------------+
.. _DEP/package:
pyTooling Package (Mandatory)
*****************************
.. rubric:: Manually Installing Package Requirements
Use the :file:`requirements.txt` file to install all dependencies via ``pip3`` or install the package directly from
PyPI (see :ref:`INSTALL`).
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip3 install -U -r requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip install -U -r requirements.txt
.. rubric:: Dependency List
When installed as ``pyTooling``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| *No dependencies* | — — — — | — — — — | — — — — |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
When installed as ``pyTooling[packaging]``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| `setuptools <https://GitHub.com/tartley/colorama>`__ | ≥80.0 | `BSD-3-Clause <https://GitHub.com/tartley/colorama/blob/master/LICENSE.txt>`__ | None |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. todo:: investigate dependencies and licenses of setuptools.
When installed as ``pyTooling[terminal]``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| `colorama <https://GitHub.com/tartley/colorama>`__ | ≥0.4.6 | `BSD-3-Clause <https://GitHub.com/tartley/colorama/blob/master/LICENSE.txt>`__ | None |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
When installed as ``pyTooling[yaml]``:
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| `ruamel.yaml <https://sourceforge.net/projects/ruamel-yaml/>`__ | ≥0.18 | `MIT <https://sourceforge.net/p/ruamel-yaml/code/ci/default/tree/LICENSE>`__ | *Not yet evaluated.* |
+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. todo:: investigate dependencies and licenses of ruamel.yaml.
.. _DEP/testing:
Unit Testing (Optional)
***********************
Unit Testing / Coverage / Type Checking (Optional)
==================================================
Additional Python packages needed for testing, code coverage collection and static type checking. These packages are
only needed for developers or on a CI server, thus sub-dependencies are not evaluated further.
.. rubric:: Manually Installing Test Requirements
Use the :file:`tests/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r tests/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r tests\requirements.txt
.. rubric:: Dependency List - Unit Testing
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=====================================================================+=============+========================================================================================+======================+
| `pytest <https://GitHub.com/pytest-dev/pytest>`__ | ≥8.4 | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__ | ≥6.2 | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `Coverage <https://GitHub.com/nedbat/coveragepy>`__ | ≥7.10 | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `mypy <https://GitHub.com/python/mypy>`__ | ≥1.17 | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.14 | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥6.0 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
Unit Testing with Benchmarking (Optional)
=========================================
Further Python packages are needed for benchmarking. These packages are only needed for developers or on a CI server,
thus sub-dependencies are not evaluated further.
.. rubric:: Manually Installing Benchmarking Requirements
Use the :file:`tests/benchmark/requirements.txt` file to install all dependencies via ``pip3``. The file will
recursively install the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r tests/benchmark/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r tests\benchmark\requirements.txt
.. rubric:: Dependency List - With Benchmark Testing
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+====================================================================+=============+========================================================================================+======================+
| `pytest-benchmark <https://GitHub.com/ionelmc/pytest-benchmark>`__ | ≥4.0.0 | `BSD 2-Clause <https://GitHub.com/ionelmc/pytest-benchmark/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
Unit Testing with Performance Testing (Optional)
================================================
Further Python packages are needed for performance testing (comparison). These packages are only needed for developers
or on a CI server, thus sub-dependencies are not evaluated further.
.. rubric:: Manually Installing Benchmarking Requirements
Use the :file:`tests/performance/requirements.txt` file to install all dependencies via ``pip3``. The file will
recursively install the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r tests/performance/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r tests\performance\requirements.txt
.. rubric:: Dependency List - With Performance Testing
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+====================================================================+=============+========================================================================================+======================+
| `anytree <https://GitHub.com/c0fec0de/anytree>`__ | ≥2.13 | `Apache 2 <https://GitHub.com/c0fec0de/anytree/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `itertree <https://GitHub.com/BR1py/itertree>`__ | ≥1.1 | `MIT <https://GitHub.com/BR1py/itertree/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `treelib <https://GitHub.com/caesar0301/treelib>`__ | ≥1.7 | `Apache 2 <https://GitHub.com/caesar0301/treelib/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `networkx <https://GitHub.com/networkx/networkx>`__ | ≥3.4 | `BSD 3-Clause <https://GitHub.com/networkx/networkx/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `igraph <https://GitHub.com/igraph/python-igraph>`__ | ≥0.11 | `GPL-2.0 <https://GitHub.com/igraph/python-igraph/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+--------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
.. _DEP/documentation:
Sphinx Documentation (Optional)
*******************************
Additional Python packages needed for documentation generation. These packages are only needed for developers or on a
CI server, thus sub-dependencies are not evaluated further.
.. rubric:: Manually Installing Documentation Requirements
Use the :file:`doc/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r doc/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r doc\requirements.txt
.. rubric:: Dependency List
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.5 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.2 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥1.0 | `BSD <https://GitHub.com/mgaitan/sphinxcontrib-mermaid/blob/master/LICENSE.rst>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `autoapi <https://GitHub.com/carlos-jenkins/autoapi>`__ | ≥2.0.1 | `Apache License, 2.0 <https://GitHub.com/carlos-jenkins/autoapi/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_btd_theme <https://GitHub.com/buildthedocs/sphinx.theme>`__ | ≥0.5.2 | `MIT <https://GitHub.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__ | ≥0.6 | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx-copybutton <https://GitHub.com/executablebooks/sphinx-copybutton>`__ | ≥0.5 | `MIT <https://GitHub.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥3.2 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `ruamel.yaml <https://sourceforge.net/projects/ruamel-yaml/>`__ | ≥0.18 | `MIT <https://sourceforge.net/p/ruamel-yaml/code/ci/default/tree/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _DEP/packaging:
Packaging (Optional)
********************
Additional Python packages needed for installation package generation. These packages are only needed for developers or
on a CI server, thus sub-dependencies are not evaluated further.
.. rubric:: Manually Installing Packaging Requirements
Use the :file:`build/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r build/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r build\requirements.txt
.. rubric:: Dependency List
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.5 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _DEP/publishing:
Publishing (CI-Server only)
***************************
Additional Python packages needed for publishing the generated installation package to e.g, PyPI or any equivalent
services. These packages are only needed for maintainers or on a CI server, thus sub-dependencies are not evaluated
further.
.. rubric:: Manually Installing Publishing Requirements
Use the :file:`dist/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.
.. tab-set::
.. tab-item:: Linux/macOS
:sync: Linux
.. code-block:: bash
pip install -U -r dist/requirements.txt
.. tab-item:: Windows
:sync: Windows
.. code-block:: powershell
pip3 install -U -r dist\requirements.txt
.. rubric:: Dependency List
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+==========================================================+==============+===========================================================================================+======================+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
| `Twine <https://GitHub.com/pypa/twine/>`__ | ≥6.1 | `Apache License, 2.0 <https://github.com/pypa/twine/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
|
