Skip to content

Latest commit

 

History

History
262 lines (171 loc) · 20.1 KB

Dependency.rst

File metadata and controls

262 lines (171 loc) · 20.1 KB

Dependencies

Libraries.io Vulnerabilities Summary
Libraries.io status for latest release Snyk Vulnerabilities for GitHub Repo

sphinx-reports Package (Mandatory)

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

Dependency List

When installed as pyTooling:

Package Version License Dependencies
pyTooling ≥8.8 Apache License, 2.0 None 
.. TODO:: document the dependency to

   * Sphinx
   * docstr_coverage
   * interrogate
   * pyEDAA.Reports

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.

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

Dependency List - Unit Testing

Package Version License Dependencies
pytest ≥9.0 MIT Not yet evaluated.
pytest-cov ≥7.0 MIT Not yet evaluated.
Coverage ≥7.12 Apache License, 2.0 Not yet evaluated.
mypy ≥1.19 MIT Not yet evaluated.
typing-extensions ≥4.15 PSF-2.0 Not yet evaluated.
lxml ≥6.0 BSD 3-Clause Not yet evaluated.

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.

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

Dependency List

Package Version License Dependencies
pyTooling ≥8.8 Apache License, 2.0 None
Sphinx ≥9.0 BSD 3-Clause Not yet evaluated.
sphinxcontrib-mermaid ≥1.2 BSD Not yet evaluated.
autoapi ≥2.0.1 Apache License, 2.0 Not yet evaluated.
sphinx_btd_theme ≥0.5.2 MIT Not yet evaluated.
sphinx_design ≥0.6 MIT Not yet evaluated.
sphinx-copybutton ≥0.5 MIT Not yet evaluated.
sphinx_autodoc_typehints ≥3.5 MIT Not yet evaluated. 
.. TODO:: document the usage of

   * autoapi
   * sphinxcontrib-mermaid
   * theme v2?
   * sphinx-design

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.

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

Dependency List

Package Version License Dependencies
pyTooling ≥8.8 Apache License, 2.0 None
wheel ≥0.45 MIT Not yet evaluated.

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.

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

Dependency List

Package Version License Dependencies
wheel ≥0.45 MIT Not yet evaluated.
Twine ≥6.2 Apache License, 2.0 Not yet evaluated.