Dependencies

pyTooling.Sphinx 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 pyTooling.Sphinx package.

Package	Version	License	Dependencies
pyTooling	any	Apache License 2.0	none
sphinx	≥9.1	BSD 2-Clause Simplified License	alabaster ≥0.7 (BSD 2-Clause Simplified License) babel ≥2.13 (BSD 3-Clause Revised License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, GNU General Public License v3.0 or later) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) packaging ≥23.0 (Apache License 2.0, BSD 2-Clause Simplified License) Pygments ≥2.17 (BSD 2-Clause Simplified License) requests ≥2.30 (Apache License 2.0) roman-numerals ≥1.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥2.2 (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)

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.

Linux/macOS

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

Windows

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

Dependency List

Dependencies for unit testing and code coverage.

Package	Version	License	Dependencies
Coverage	≥7.15	Apache License 2.0	none
pytest	≥9.1	MIT License	colorama ≥0.4 (BSD 3-Clause Revised License) exceptiongroup ≥1 (MIT License) 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)
pyTooling	any	Apache License 2.0	none
sphinx	≥9.1	BSD 2-Clause Simplified License	alabaster ≥0.7 (BSD 2-Clause Simplified License) babel ≥2.13 (BSD 3-Clause Revised License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, GNU General Public License v3.0 or later) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) packaging ≥23.0 (Apache License 2.0, BSD 2-Clause Simplified License) Pygments ≥2.17 (BSD 2-Clause Simplified License) requests ≥2.30 (Apache License 2.0) roman-numerals ≥1.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥2.2 (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 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.

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, GNU General Public License v3.0 or later)
pyTooling	any	Apache License 2.0	none
sphinx	≥9.1	BSD 2-Clause Simplified License	alabaster ≥0.7 (BSD 2-Clause Simplified License) babel ≥2.13 (BSD 3-Clause Revised License) colorama ≥0.4 (BSD 3-Clause Revised License) docutils ≥0.21 (BSD 2-Clause Simplified License, GNU General Public License v3.0 or later) imagesize ≥1.3 (MIT License) Jinja2 ≥3.1 (BSD 3-Clause Revised License) packaging ≥23.0 (Apache License 2.0, BSD 2-Clause Simplified License) Pygments ≥2.17 (BSD 2-Clause Simplified License) requests ≥2.30 (Apache License 2.0) roman-numerals ≥1.0 (BSD Zero Clause License, Creative Commons Zero v1.0 Universal) snowballstemmer ≥2.2 (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.13	MIT License	sphinx ≥9.1 (BSD 2-Clause Simplified License)
sphinx-copybutton	≥0.5	MIT License	sphinx ≥1.8 (BSD 2-Clause Simplified License)
sphinx_design	≥0.7	MIT License	sphinx ≥7 (BSD 2-Clause Simplified License)
sphinx_reports	≥0.11	Apache License 2.0	Coverage ≥7.15 (Apache License 2.0) docstr_coverage ≥2.3 (MIT License) docutils ≥0.22 (BSD 2-Clause Simplified License, GNU General Public License v3.0 or later) docutils_stubs ≥0.0 (The Unlicense) pyEDAA.Reports ≥0.18 (Apache License 2.0) pyTooling ≥8.19 (Apache License 2.0) sphinx ≥9.1 (BSD 2-Clause Simplified License)
sphinx_rtd_theme	≥3.1	MIT License	docutils >0.18 (BSD 2-Clause Simplified License, GNU General Public License v3.0 or later) sphinx ≥6 (BSD 2-Clause Simplified License) sphinxcontrib-jquery ≥4 (BSD Zero Clause License)
sphinxcontrib-mermaid	≥2.1	BSD 2-Clause Simplified License	jinja2 (BSD 3-Clause Revised License) pyyaml (MIT License) sphinx (BSD 2-Clause Simplified License)
xmlschema	≥4.3	MIT License	elementpath ≥5.1 (MIT License)