Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
271 additions
and
43 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: pip | ||
| directory: "/" | ||
| target-branch: dev | ||
| commit-message: | ||
| prefix: "[Dependabot]" | ||
| labels: | ||
| - Dependencies | ||
| assignees: | ||
| - Paebbels | ||
| reviewers: | ||
| - Paebbels | ||
| schedule: | ||
| interval: daily |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # New Features | ||
| * tbd | ||
|
|
||
| # Changes | ||
| * tbd | ||
|
|
||
| # Bug Fixes | ||
| * tbd |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,115 @@ | ||
| .. _dependency: | ||
|
|
||
| Dependencies | ||
| ############ | ||
|
|
||
| * py-flags | ||
| .. |img-pyGenericPath-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyGenericPath | ||
| :alt: Libraries.io status for latest release | ||
| :height: 22 | ||
| :target: https://libraries.io/github/Paebbels/pyGenericPath | ||
| .. |img-pyGenericPath-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyGenericPath | ||
| :alt: Requires.io | ||
| :height: 22 | ||
| :target: https://requires.io/github/Paebbels/pyGenericPath/requirements/?branch=master | ||
|
|
||
| +------------------------------------------+------------------------------------------+ | ||
| | `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ | | ||
| +==========================================+==========================================+ | ||
| | |img-pyGenericPath-lib-status| | |img-pyGenericPath-req-status| | | ||
| +------------------------------------------+------------------------------------------+ | ||
|
|
||
| .. _dependency-package: | ||
|
|
||
| pyGenericPath 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`). | ||
|
|
||
| .. code-block:: shell | ||
| pip3 install -U -r requirements.txt | ||
| .. rubric:: Dependency List | ||
|
|
||
| +----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| | **Package** | **Version** | **License** | **Dependencies** | | ||
| +================================================================+=============+===========================================================================================+======================================================================================================================================================================+ | ||
| | `py-flags <https://github.com/pasztorpisti/py-flags>`__ | ≥1.1.4 | `MIT <https://github.com/pasztorpisti/py-flags/blob/master/LICENSE.txt>`__ | * `dictionaries <https://github.com/pasztorpisti/py-dictionaries>`__ (`MIT <https://github.com/pasztorpisti/py-dictionaries/blob/master/LICENSE.txt>`__) | | ||
| +----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
| | `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>`__) | | ||
| | | | | * `six <https://github.com/benjaminp/six>`__ (`MIT <https://github.com/benjaminp/six/blob/master/LICENSE>`__) | | ||
| +----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
|
|
||
|
|
||
| .. _dependency-testing: | ||
|
|
||
| Unit Testing / Coverage (Optional) | ||
| ********************************** | ||
|
|
||
| Additional Python packages needed for testing and code coverage collection. | ||
| 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. | ||
|
|
||
| .. code-block:: shell | ||
| pip3 install -U -r tests/requirements.txt | ||
| .. rubric:: Dependency List | ||
|
|
||
| +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | ||
| | **Package** | **Version** | **License** | **Dependencies** | | ||
| +===========================================================+=============+========================================================================================+======================+ | ||
| | `pytest <https://github.com/pytest-dev/pytest>`__ | ≥6.2.4 | `MIT <https://github.com/pytest-dev/pytest/blob/master/LICENSE>`__ | *Not yet evaluated.* | | ||
| +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | ||
| | `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.* | | ||
| +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | ||
| | `Coverage <https://github.com/nedbat/coveragepy>`__ | ≥5.5 | `Apache License, 2.0 <https://github.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* | | ||
| +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ | ||
|
|
||
|
|
||
| .. _dependency-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. | ||
|
|
||
| .. code-block:: shell | ||
| pip3 install -U -r doc/requirements.txt | ||
| .. rubric:: Dependency List | ||
|
|
||
| +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ | ||
| | **Package** | **Version** | **License** | **Dependencies** | | ||
| +=================================================================================================+==============+==========================================================================================================+======================+ | ||
| | `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.* | | ||
| +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ | ||
| | `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_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.* | | ||
| +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ | ||
| | `Pygments <https://github.com/pygments/pygments>`__ | ≥2.9.0 | `BSD 2-Clause <https://github.com/pygments/pygments/blob/master/LICENSE>`__ | *Not yet evaluated.* | | ||
| +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ |
Oops, something went wrong.