Dependencies

Libraries.io

Vulnerabilities Summary

Libraries.io status for latest release

Snyk Vulnerabilities for GitHub Repo

pyEDAA.Reports Package (Mandatory)

Python packages pyEDAA.Reports requires at runtime.

Manually Installing Package Requirements

Use the requirements.txt file to install all dependencies via pip3 or install the package directly from PyPI (see Installation/Updates).

pip3 install -U -r requirements.txt
pip install -U -r requirements.txt

Dependency List

Mandatory dependencies of the pyEDAA.Reports package.
Package Version License Dependencies

jsonschema

≥4.26

MIT License

lxml

≥6.1

BSD 3-Clause Revised License

none

pyTooling[terminal]

≥10.1

Apache License 2.0

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.

Manually Installing Test Requirements

Use the tests/unit/requirements.txt file to install all dependencies via pip3. The file will recursively install the mandatory dependencies too. tests/requirements.txt installs the requirements of unit tests, application tests and static type checking at once.

pip3 install -U -r tests/unit/requirements.txt
pip install -U -r tests\unit\requirements.txt

Dependency List

Dependencies for unit testing and code coverage.
Package Version License Dependencies

Coverage

≥7.17

Apache License 2.0

none

docstr_coverage

≥2.3

MIT License

jsonschema

≥4.26

MIT License

lxml

≥6.1

BSD 3-Clause Revised License

none

pytest

≥9.1

MIT License

pytest-cov

≥7.1

MIT License

pytest-xdist

≥3.8

MIT License

pyTooling[terminal]

≥10.1

Apache License 2.0

xmlschema

≥4.3

MIT License

Application Testing (Optional)

Additional Python packages needed to run the application tests, which exercise the installed pyedaa-reports command line rather than the package’s classes. These packages are only needed for developers or on a CI server.

Manually Installing Application Test Requirements

Use the tests/app/requirements.txt file to install all dependencies via pip3. The file will recursively install the mandatory dependencies too.

pip3 install -U -r tests/app/requirements.txt
pip install -U -r tests\app\requirements.txt

Dependency List

Dependencies for application testing.
Package Version License Dependencies

jsonschema

≥4.26

MIT License

lxml

≥6.1

BSD 3-Clause Revised License

none

pytest

≥9.1

MIT License

pytest-xdist

≥3.8

MIT License

pyTooling[terminal]

≥10.1

Apache License 2.0

xmlschema

≥4.3

MIT License

Static Type Checking (Optional)

Additional Python packages needed for static type checking. These packages are only needed for developers or on a CI server.

Manually Installing Type Checking Requirements

Use the tests/typing/requirements.txt file to install all dependencies via pip3. The file will recursively install the mandatory dependencies too.

pip3 install -U -r tests/typing/requirements.txt
pip install -U -r tests\typing\requirements.txt

Dependency List

Dependencies for static type checking.
Package Version License Dependencies

jsonschema

≥4.26

MIT License

lxml

≥6.1

BSD 3-Clause Revised License

none

lxml-stubs

≥0.5

Apache License 2.0

none

mypy[reports]

≥2.4

MIT License

pyTooling[terminal]

≥10.1

Apache License 2.0

typing-extensions

≥4.16

Python Software Foundation License 2.0

none

Sphinx Documentation (Optional)

Additional Python packages needed for documentation generation. These packages are only needed for developers or on a CI server.

Manually Installing Documentation Requirements

Use the doc/requirements.txt file to install all dependencies via pip3. The file will recursively install the mandatory dependencies too.

pip3 install -U -r doc/requirements.txt
pip install -U -r doc\requirements.txt

Dependency List

Dependencies for building this documentation.
Package Version License Dependencies

autoapi

≥2.0

Apache License 2.0

none

docutils

≥0.22

BSD 2-Clause Simplified License, BSD 3-Clause Revised License

none

docutils_stubs

≥0.0

The Unlicense

jsonschema

≥4.26

MIT License

lxml

≥6.1

BSD 3-Clause Revised License

none

pyTooling[terminal]

≥10.1

Apache License 2.0

pyTooling.Sphinx

any

Apache License 2.0

ruamel.yaml

≥0.19

MIT License

none

sphinx

≥9.1

BSD 2-Clause Simplified License

sphinx_autodoc_typehints

≥3.17

MIT License

sphinx-copybutton

≥0.5

MIT License

sphinx_design

≥0.7

MIT License

sphinx_rtd_theme

≥3.1

MIT License

sphinxcontrib-autoprogram

≥0.1

BSD 2-Clause Simplified License

sphinxcontrib-mermaid

≥2.1

BSD 2-Clause Simplified License

Packaging (Optional)

Additional Python packages needed for installation package generation. These packages are only needed for developers or on a CI server.

Building an Installation Package

pyproject.toml lists them as build requirements ([build-system]), so build installs them into an isolated build environment itself.

python3 -m build --wheel
python -m build --wheel

Dependency List

Dependencies for generating an installation package.
Package Version License Dependencies

pyTooling

≥10.1

Apache License 2.0

none

setuptools

≥84.2

MIT License

none

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.

Manually Installing Publishing Requirements

Use the dist/requirements.txt file to install all dependencies via pip3. The file will recursively install the mandatory dependencies too.

pip3 install -U -r dist/requirements.txt
pip install -U -r dist\requirements.txt

Dependency List

Dependencies for publishing the package.
Package Version License Dependencies

twine

≥7.0

Apache License 2.0

wheel

≥0.48

MIT License