Skip to content

Commit

Permalink
Updated requirements and dependencies.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Paebbels
Paebbels committed Jan 8, 2024
1 parent 24d1431 commit e2a6c87
Show file tree
Hide file tree
Showing 3 changed files with 132 additions and 37 deletions.
2 changes: 1 addition & 1 deletion dist/requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
wheel>=0.38.1
wheel >= 0.40.0
twine >= 4.0.2
144 changes: 113 additions & 31 deletions doc/Dependency.rst
View file
Original file line number Diff line number Diff line change
@@ -1,34 +1,60 @@
.. _DEP:

Dependency
##########
Dependencies
############

.. |img-ProjectModel-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyVersioning
.. |img-pyTooling-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
:alt: Libraries.io status for latest release
:height: 22
:target: https://libraries.io/github/Paebbels/pyVersioning
.. |img-ProjectModel-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyVersioning
:alt: Requires.io
:target: https://libraries.io/github/pyTooling/sphinx-reports
.. |img-pyTooling-vul-status| image:: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports
:alt: Snyk Vulnerabilities for GitHub Repo
:height: 22
:target: https://requires.io/github/Paebbels/pyVersioning/requirements/?branch=main
:target: https://img.shields.io/snyk/vulnerabilities/github/pyTooling/sphinx-reports

+------------------------------------------+------------------------------------------+
| `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ |
| `Libraries.io <https://libraries.io/>`_ | Vulnerabilities Summary |
+==========================================+==========================================+
| |img-ProjectModel-lib-status| | |img-ProjectModel-req-status| |
| |img-pyTooling-lib-status| | |img-pyTooling-vul-status| |
+------------------------------------------+------------------------------------------+


.. _DEP/package:

pyVersioning Package
********************
sphinx-reports 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
+-------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+===============================================================================+=============+======================================================================================================+===========================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥5.0.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
+-------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rubric:: Dependency List

When installed as ``pyTooling``:

+-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+=================================================================+=============+===========================================================================================+========================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥5.0.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
+-----------------------------------------------------------------+-------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+

.. TODO:: document the dependency to

Expand All @@ -39,8 +65,11 @@ pyVersioning Package

.. _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.
Expand All @@ -51,12 +80,23 @@ only needed for developers or on a CI server, thus sub-dependencies are not eval
Use the :file:`tests/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.

.. code-block:: shell
.. tab-set::

pip3 install -U -r tests/requirements.txt
.. tab-item:: Linux/MacOS
:sync: Linux

.. code-block:: bash
.. rubric:: Dependency List
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** |
Expand All @@ -71,7 +111,7 @@ the mandatory dependencies too.
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `typing-extensions <https://GitHub.com/python/typing_extensions>`__ | ≥4.7.1 | `PSF-2.0 <https://github.com/python/typing_extensions/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥4.6.4 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
| `lxml <https://GitHub.com/lxml/lxml>`__ | ≥4.9 | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
+---------------------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+


Expand All @@ -89,9 +129,21 @@ CI server, thus sub-dependencies are not evaluated further.
Use the :file:`doc/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
the mandatory dependencies too.

.. code-block:: shell
.. tab-set::

.. tab-item:: Linux/MacOS
:sync: Linux

.. code-block:: bash
pip install -U -r doc/requirements.txt
.. tab-item:: Windows
:sync: Windows

pip3 install -U -r doc/requirements.txt
.. code-block:: powershell
pip3 install -U -r doc\requirements.txt
.. rubric:: Dependency List
Expand All @@ -103,9 +155,15 @@ the mandatory dependencies too.
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥5.3.0 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinxcontrib-mermaid <https://GitHub.com/mgaitan/sphinxcontrib-mermaid>`__ | ≥0.9.2 | `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_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.* |
| `sphinx_design <https://GitHub.com/executablebooks/sphinx-design>`__ | ≥0.5.0 | `MIT <https://GitHub.com/executablebooks/sphinx-design/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx-copybutton <https://GitHub.com/executablebooks/sphinx-copybutton>`__ | ≥0.5.2 | `MIT <https://GitHub.com/executablebooks/sphinx-copybutton/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__ | ≥1.24.0 | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__ | *Not yet evaluated.* |
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand All @@ -132,9 +190,21 @@ on a CI server, thus sub-dependencies are not evaluated further.
Use the :file:`build/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.

.. code-block:: shell
.. tab-set::

.. tab-item:: Linux/MacOS
:sync: Linux

pip3 install -U -r build/requirements.txt
.. 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
Expand All @@ -144,7 +214,7 @@ install the mandatory dependencies too.
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥5.0.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.38.1 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.40.0 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+


Expand All @@ -163,17 +233,29 @@ further.
Use the :file:`dist/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively
install the mandatory dependencies too.

.. code-block:: shell
.. 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
pip3 install -U -r dist\requirements.txt
.. rubric:: Dependency List

+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
| **Package** | **Version** | **License** | **Dependencies** |
+==========================================================+==============+===========================================================================================+======================+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.38.1 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.40.0 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
| `Twine <https://GitHub.com/pypa/twine/>`__ | any | `Apache License, 2.0 <https://github.com/pypa/twine/blob/main/LICENSE>`__ | *Not yet evaluated.* |
| `Twine <https://GitHub.com/pypa/twine/>`__ | ≥4.0.2 | `Apache License, 2.0 <https://github.com/pypa/twine/blob/main/LICENSE>`__ | *Not yet evaluated.* |
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
Loading

0 comments on commit e2a6c87

Please sign in to comment.