Dependency

pyVHDLModel 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).

Linux/macOS

pip3 install -U -r requirements.txt

Windows

pip install -U -r requirements.txt

Dependency List

Mandatory dependencies of the pyVHDLModel package.

Package	Version	License	Dependencies
pyTooling	≥10.0	Apache License 2.0	none

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.

Manually Installing Test Requirements

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

Linux/macOS

pip3 install -U -r tests/requirements.txt

Windows

pip install -U -r tests\requirements.txt

Dependency List

Dependencies for unit testing, code coverage and static type checking.

Package	Version	License	Dependencies
Coverage	≥7.16	Apache License 2.0	none
lxml	≥6.1	BSD 3-Clause Revised License	none
mypy	≥2.4	MIT License	ast-serialize ≥0.11 (MIT License) librt ≥0.16 (MIT License) lxml (BSD 3-Clause Revised License) mypy_extensions ≥1.0 (MIT License) pathspec ≥1.0 (Mozilla Public License 2.0) tomli ≥1.1 (MIT License) typing_extensions ≥4.6 (Python Software Foundation License 2.0) typing_extensions ≥4.14 (Python Software Foundation License 2.0)
pytest	≥9.1	MIT License	colorama ≥0.4 (BSD 3-Clause Revised License) exceptiongroup ≥1 (MIT License) typing_extensions ≥4.6 (Python Software Foundation License 2.0) iniconfig ≥1.0 (MIT License) packaging ≥22 (Apache License 2.0, BSD 2-Clause Simplified License) pluggy ≥1.5 (MIT License) pygments ≥2.7 (BSD 2-Clause Simplified License) tomli ≥1 (MIT License)
pytest-cov	≥7.1	MIT License	Coverage ≥7.10 (Apache License 2.0) pluggy ≥1.2 (MIT License) pytest ≥7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) exceptiongroup ≥1 (MIT License) typing_extensions ≥4.6 (Python Software Foundation License 2.0) iniconfig ≥1.0 (MIT License) packaging ≥22 (Apache License 2.0, BSD 2-Clause Simplified License) pluggy ≥1.5 (MIT License) pygments ≥2.7 (BSD 2-Clause Simplified License) tomli ≥1 (MIT License)
pytest-xdist	≥3.8	MIT License	execnet ≥2.1 (MIT License) pytest ≥7.0 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) exceptiongroup ≥1 (MIT License) typing_extensions ≥4.6 (Python Software Foundation License 2.0) iniconfig ≥1.0 (MIT License) packaging ≥22 (Apache License 2.0, BSD 2-Clause Simplified License) pluggy ≥1.5 (MIT License) pygments ≥2.7 (BSD 2-Clause Simplified License) tomli ≥1 (MIT License)
pyTooling	≥10.0	Apache License 2.0	none
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.

Linux/macOS

pip3 install -U -r doc/requirements.txt

Windows

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
docutils_stubs	≥0.0	The Unlicense	docutils ≥0.14 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License)
pyTooling	≥10.0	Apache License 2.0	none
pyTooling.Sphinx	≥0.1	Apache License 2.0	pyEDAA.Reports ≥0.20 (Apache License 2.0) jsonschema ≥4.26 (MIT License) attrs ≥22.2 (MIT License) jsonschema-specifications ≥2023.03 (MIT License) referencing ≥0.31 (MIT License) attrs ≥22.2 (MIT License) rpds-py ≥0.7 (MIT License) typing_extensions ≥4.4 (Python Software Foundation License 2.0) referencing ≥0.28 (MIT License) attrs ≥22.2 (MIT License) rpds-py ≥0.7 (MIT License) typing_extensions ≥4.4 (Python Software Foundation License 2.0) rpds-py ≥0.25 (MIT License) lxml ≥6.1 (BSD 3-Clause Revised License) pyTooling ≥10.0 (Apache License 2.0) colorama ≥0.4 (BSD 3-Clause Revised License) ruamel.yaml ≥0.19 (MIT License) pyTooling ≥10.0 (Apache License 2.0) aiohttp ≥3.12 (Apache License 2.0, MIT License) aiohappyeyeballs ≥2.5 (Python Software Foundation License 2.0) aiosignal ≥1.4 (Apache License 2.0) frozenlist ≥1.1 (Apache License 2.0) typing_extensions ≥4.2 (Python Software Foundation License 2.0) async-timeout ≥4.0 (Apache License 2.0) attrs ≥17.3 (MIT License) frozenlist ≥1.1 (Apache License 2.0) multidict ≥4.5 (Apache License 2.0) propcache ≥0.2 (Apache License 2.0) typing_extensions ≥4.4 (Python Software Foundation License 2.0) yarl ≥1.25 (Apache License 2.0) idna ≥2.0 (BSD 3-Clause Revised License) multidict ≥4.0 (Apache License 2.0) propcache ≥0.2 (Apache License 2.0) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) sphinx ≥9.1 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License) xmlschema ≥4.3 (MIT License) elementpath ≥5.1 (MIT License)
sphinx	≥9.1	BSD 2-Clause Simplified License	alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License)
sphinx_autodoc_typehints	≥3.17	MIT License	sphinx ≥9.1 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License) typing_extensions ≥4.16 (Python Software Foundation License 2.0)
sphinx-copybutton	≥0.5	MIT License	sphinx ≥1.8 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License)
sphinx_design	≥0.7	MIT License	sphinx ≥7 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License)
sphinx_rtd_theme	≥3.1	MIT License	docutils >0.18 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) sphinx ≥6 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License) sphinxcontrib-jquery ≥4 (BSD Zero Clause License) sphinx ≥1.8 (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License)
sphinxcontrib-mermaid	≥2.1	BSD 2-Clause Simplified License	Jinja2 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) pyyaml (MIT License) sphinx (BSD 2-Clause Simplified License) alabaster ≥1.0 (BSD 2-Clause Simplified License) babel ≥2.18 (BSD 3-Clause Revised License) pytz ≥2015.7 (MIT License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) MarkupSafe ≥2.0 (BSD 3-Clause Revised License) packaging ≥25.0 (Apache License 2.0, BSD 2-Clause Simplified License) pygments ≥2.19 (BSD 2-Clause Simplified License) requests ≥2.32 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) roman-numerals ≥3.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥3.0 (BSD 3-Clause Revised License) sphinxcontrib-applehelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-devhelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-htmlhelp ≥2.0 (BSD 2-Clause Simplified License) sphinxcontrib-jsmath ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-qthelp ≥1.0 (BSD 2-Clause Simplified License) sphinxcontrib-serializinghtml ≥1.1 (BSD 2-Clause Simplified License)

Packaging (Optional)

The build requirements - setuptools and pyTooling, whose pyTooling.Packaging describes the package in setup.py - are declared in pyproject.toml ([build-system]). pip and python -m build install them into an isolated build environment.

Publishing (CI-Server only)

Additional Python packages needed for publishing the generated installation package to PyPI or an equivalent service. 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.

Linux/macOS

pip3 install -U -r dist/requirements.txt

Windows

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	id (Apache License 2.0) urllib3 ≥2 (MIT License) keyring ≥21.2 (MIT License) importlib_metadata ≥4.11 (Apache License 2.0) zipp ≥3.20 (MIT License) jaraco.classes (MIT License) more-itertools (MIT License) jaraco.context (MIT License) backports.tarfile (MIT License) jaraco.functools (MIT License) more-itertools (MIT License) jeepney ≥0.4 (MIT License) pywin32-ctypes ≥0.2 (BSD 3-Clause Revised License) SecretStorage ≥3.2 (BSD 3-Clause Revised License) cryptography ≥2.0 (Apache License 2.0, BSD 3-Clause Revised License) cffi ≥2.0 (MIT No Attribution) pycparser (BSD 3-Clause Revised License) typing_extensions ≥4.13 (Python Software Foundation License 2.0) jeepney ≥0.6 (MIT License) packaging ≥26.1 (Apache License 2.0, BSD 2-Clause Simplified License) readme-renderer ≥35.0 (Apache License 2.0) docutils ≥0.21 (BSD 2-Clause Simplified License, BSD 3-Clause Revised License) nh3 ≥0.2 (MIT License) pygments ≥2.5 (BSD 2-Clause Simplified License) requests ≥2.20 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) requests-toolbelt ≥0.8 (Apache License 2.0) requests ≥2.0 (Apache License 2.0) certifi ≥2023.5 (Mozilla Public License 2.0) charset_normalizer ≥2 (MIT License) idna ≥2.5 (BSD 3-Clause Revised License) urllib3 ≥1.26 (MIT License) rfc3986 ≥1.4 (Apache License 2.0) rich ≥14.3 (MIT License) markdown-it-py ≥2.2 (MIT License) mdurl ≥0.1 (MIT License) pygments ≥2.13 (BSD 2-Clause Simplified License) urllib3 ≥1.26 (MIT License)
wheel	≥0.48	MIT License	packaging ≥24.0 (Apache License 2.0, BSD 2-Clause Simplified License)