Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

Commit af94acc

Browse files
PaebbelsPaebbels
committed
Updated dependencies.
1 parent cb39c59 commit af94acc

3 files changed

Lines changed: 123 additions & 13 deletions

File tree

‎doc/Dependencies.rst‎

Lines changed: 118 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,121 @@
1+
.. _dependency:
2+
13
Dependencies
24
############
35

4-
+------------------------+--------------------+-----------------------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
5-
| Package | License | PyPI URL | Documentation | Source |
6-
+========================+====================+===========================================================+=========================================================+=======================================================================+
7-
| colorama | BSD-3-Clause | `colorama <https://pypi.org/project/colorama>`_ | | `tartley/colorama <https://github.com/tartley/colorama>`_ |
8-
+------------------------+--------------------+-----------------------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
9-
| pyExceptions | Apache License 2.0 | `pyExceptions <https://pypi.org/project/pyExceptions>`_ | `pyExceptions <https://pyExceptions.readthedocs.io>`_ | `Paebbels/pyExceptions <https://github.com/Paebbels/pyExceptions>`_ |
10-
+------------------------+--------------------+-----------------------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
11-
| pyMetaClasses | Apache License 2.0 | `pyMetaClasses <https://pypi.org/project/pyMetaClasses>`_ | `pyMetaClasses <https://pyMetaClasses.readthedocs.io>`_ | `Paebbels/pyMetaClasses <https://github.com/Paebbels/pyMetaClasses>`_ |
12-
+------------------------+--------------------+-----------------------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
6+
.. |img-pyTerminalUI-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyTerminalUI
7+
:alt: Libraries.io status for latest release
8+
:height: 22
9+
:target: https://libraries.io/github/Paebbels/pyTerminalUI
10+
.. |img-pyTerminalUI-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyTerminalUI
11+
:alt: Requires.io
12+
:height: 22
13+
:target: https://requires.io/github/Paebbels/pyTerminalUI/requirements/?branch=master
14+
15+
+------------------------------------------+------------------------------------------+
16+
| `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ |
17+
+==========================================+==========================================+
18+
| |img-pyTerminalUI-lib-status| | |img-pyTerminalUI-req-status| |
19+
+------------------------------------------+------------------------------------------+
20+
21+
.. _dependency-package:
22+
23+
pyTerminalUI Package (Mandatory)
24+
********************************
25+
26+
.. rubric:: Manually Installing Package Requirements
27+
28+
Use the :file:`requirements.txt` file to install all dependencies via ``pip3``
29+
or install the package directly from PyPI (see :ref:`INSTALL`).
30+
31+
.. code-block:: shell
32+
33+
pip3 install -U -r requirements.txt
34+
35+
36+
.. rubric:: Dependency List
37+
38+
+----------------------------------------------------------------+-------------+-------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
39+
| **Package** | **Version** | **License** | **Dependencies** |
40+
+================================================================+=============+==========+=====================================================================+==========+======================================================================================================================================================================+
41+
| `colorama <https://github.com/tartley/colorama>`__ | ≥0.4.4 | `BSD-3-Clause <https://github.com/tartley/colorama/blob/master/LICENSE.txt>`__ | None |
42+
+----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
43+
| `pydecor <https://github.com/mplanchard/pydecor>`__ | ≥2.0.1 | `MIT <https://github.com/mplanchard/pydecor/blob/master/LICENSE>`__ | * `dill <https://github.com/uqfoundation/dill>`__ (`BSD 3-clause <https://github.com/uqfoundation/dill/blob/master/LICENSE>`__) |
44+
| | | | * `six <https://github.com/benjaminp/six>`__ (`MIT <https://github.com/benjaminp/six/blob/master/LICENSE>`__) |
45+
+----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
46+
| `pyMetaClasses <https://github.com/Paebbels/pyMetaClasses>`__ | ≥1.3.0 | `Apache License 2.0 <https://github.com/Paebbels/pyMetaClasses/blob/master/LICENSE.md>`__ | * `pydecor <https://github.com/mplanchard/pydecor>`__ (`MIT <https://github.com/mplanchard/pydecor/blob/master/LICENSE>`__; see above) |
47+
+----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
48+
| `pyExceptions <https://github.com/Paebbels/pyExceptions>`__ | ≥1.1.0 | `Apache License 2.0 <https://github.com/Paebbels/pyExceptions/blob/master/LICENSE.md>`__ | * `pydecor <https://github.com/mplanchard/pydecor>`__ (`MIT <https://github.com/mplanchard/pydecor/blob/master/LICENSE>`__; see above) |
49+
| | | | * `SphinxExtensions <https://github.com/Paebbels/SphinxExtensions>`__ (`Apache License 2.0 <https://github.com/Paebbels/SphinxExtensions/blob/master/LICENSE.md>`__) |
50+
+----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
51+
52+
53+
54+
.. _dependency-testing:
55+
56+
Unit Testing / Coverage (Optional)
57+
**********************************
58+
59+
Additional Python packages needed for testing and code coverage collection.
60+
These packages are only needed for developers or on a CI server, thus
61+
sub-dependencies are not evaluated further.
62+
63+
64+
.. rubric:: Manually Installing Test Requirements
65+
66+
Use the :file:`tests/requirements.txt` file to install all dependencies via
67+
``pip3``. The file will recursively install the mandatory dependencies too.
68+
69+
.. code-block:: shell
70+
71+
pip3 install -U -r tests/requirements.txt
72+
73+
74+
.. rubric:: Dependency List
75+
76+
+-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
77+
| **Package** | **Version** | **License** | **Dependencies** |
78+
+===========================================================+=============+========================================================================================+======================+
79+
| `pytest <https://github.com/pytest-dev/pytest>`__ | ≥6.2.4 | `MIT <https://github.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* |
80+
+-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
81+
| `pytest-cov <https://github.com/pytest-dev/pytest-cov>`__ | ≥2.12.1 | `MIT <https://github.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__ | *Not yet evaluated.* |
82+
+-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
83+
| `Coverage <https://github.com/nedbat/coveragepy>`__ | ≥5.5 | `Apache License, 2.0 <https://github.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
84+
+-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
85+
86+
87+
.. _dependency-documentation:
88+
89+
Sphinx Documentation (Optional)
90+
*******************************
91+
92+
Additional Python packages needed for documentation generation. These packages
93+
are only needed for developers or on a CI server, thus sub-dependencies are not
94+
evaluated further.
95+
96+
97+
.. rubric:: Manually Installing Documentation Requirements
98+
99+
Use the :file:`doc/requirements.txt` file to install all dependencies via
100+
``pip3``. The file will recursively install the mandatory dependencies too.
101+
102+
.. code-block:: shell
103+
104+
pip3 install -U -r doc/requirements.txt
105+
106+
107+
.. rubric:: Dependency List
108+
109+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
110+
| **Package** | **Version** | **License** | **Dependencies** |
111+
+=================================================================================================+==============+==========================================================================================================+======================+
112+
| `Sphinx <https://github.com/sphinx-doc/sphinx>`__ | ≥4.1.1 | `BSD 3-Clause <https://github.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
113+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
114+
| `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.* |
115+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
116+
| !! `sphinx_fontawesome <https://github.com/fraoustin/sphinx_fontawesome>`__ | ≥0.0.6 | `GPL 2.0 <https://github.com/fraoustin/sphinx_fontawesome/blob/master/LICENSE>`__ | *Not yet evaluated.* |
117+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
118+
| `sphinx_autodoc_typehints <https://github.com/agronholm/sphinx-autodoc-typehints>`__ | ≥1.12.0 | `MIT <https://github.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
119+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
120+
| `Pygments <https://github.com/pygments/pygments>`__ | ≥2.9.0 | `BSD 2-Clause <https://github.com/pygments/pygments/blob/master/LICENSE>`__ | *Not yet evaluated.* |
121+
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+

‎doc/conf.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141
"sphinx.ext.autodoc",
4242
'sphinx.ext.extlinks',
4343
'sphinx.ext.intersphinx',
44-
# 'sphinx.ext.inheritance_diagram',
44+
'sphinx.ext.inheritance_diagram',
4545
'sphinx.ext.todo',
46-
# 'sphinx.ext.graphviz',
46+
'sphinx.ext.graphviz',
4747
'sphinx.ext.mathjax',
4848
'sphinx.ext.ifconfig',
4949
'sphinx.ext.viewcode',
@@ -53,8 +53,8 @@
5353

5454
# BuildTheDocs extensions
5555
'btd.sphinx.autoprogram',
56-
'btd.sphinx.graphviz',
57-
'btd.sphinx.inheritance_diagram',
56+
# 'btd.sphinx.graphviz',
57+
# 'btd.sphinx.inheritance_diagram',
5858

5959
# Other extensions
6060
# 'DocumentMember',

‎doc/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ sphinx_autodoc_typehints>=1.12.0
1111
# changelog>=0.3.5
1212

1313
# BuildTheDocs Extensions (mostly patched Sphinx extensions)
14+
btd.sphinx.autoprogram
1415

1516
# Enforce newer version on ReadTheDocs (currently using 2.3.1)
1617
Pygments>=2.9.0

0 commit comments

Comments
 (0)