Dependencies

VHDLDomain Package (Mandatory)

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 VHDLDomain package.
Package Version License Dependencies

pyTooling

≥10.0

Apache License 2.0

none

pyTooling.Sphinx

≥0.1

Apache License 2.0

pyVHDLModel

≥0.40

Apache License 2.0

sphinx

≥9.1

BSD 2-Clause Simplified License

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.

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.16

Apache License 2.0

none

pytest

≥9.1

MIT License

pytest-cov

≥7.1

MIT License

pytest-xdist

≥3.8

MIT License

pyTooling

≥10.0

Apache License 2.0

none

pyTooling.Sphinx

≥0.1

Apache License 2.0

pyVHDLModel

≥0.40

Apache License 2.0

sphinx

≥9.1

BSD 2-Clause Simplified 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 Static 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

docutils_stubs

≥0.0

The Unlicense

mypy

≥2.4

MIT License

pyTooling

≥10.0

Apache License 2.0

none

pyTooling.Sphinx

≥0.1

Apache License 2.0

pyVHDLModel

≥0.40

Apache License 2.0

sphinx

≥9.1

BSD 2-Clause Simplified License

Sphinx Documentation (Optional)

Additional Python packages needed for building the documentation. 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 the documentation.
Package Version License Dependencies

autoapi

≥2.0

Apache License 2.0

none

pyTooling

≥10.0

Apache License 2.0

none

pyTooling.Sphinx

≥0.1

Apache License 2.0

pyVHDLModel

≥0.40

Apache License 2.0

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-mermaid

≥2.1

BSD 2-Clause Simplified License