Dependencies

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

pyTooling

≥10.0

Apache License 2.0

none

ruamel.yaml

≥0.19

MIT License

none

Gantt Charts (Optional)

When installed as pyTooling.GitLab[diagram], which the trace diagram and the program’s --gantt option need:

Package

Version

License

Dependencies

matplotlib

≥3.10

PSF-2.0 (matplotlib license)

contourpy, cycler, fonttools, kiwisolver, numpy, packaging, pillow, pyparsing, python-dateutil

Sphinx Domain glci (Optional)

When installed as pyTooling.GitLab[sphinx], which the glci domain needs. pyTooling.Sphinx requires Python 3.12 or newer, because Sphinx 9.1 does.

Package

Version

License

Dependencies

pyTooling.Sphinx

~=0.1.0rc3

Apache-2.0

pyTooling[pypi], sphinx, xmlschema

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

Apache License 2.0

none

matplotlib

≥3.10

Python Software Foundation License 2.0

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

ruamel.yaml

≥0.19

MIT License

none

Test Data

The pipeline run model’s tests use pipelines of public projects on gitlab.com, as GitLab’s REST API reported them, reduced to the fields GitLab reports about the pipelines and jobs. They are in the repository only, not in the package; NOTICE.md lists them too.

Content

Files

Source

License of the source project

Pipeline 2954836704 with its jobs, its trigger job and its child pipeline

tests/data/Runs/GitLabDevelopmentKit.json

gitlab-org/gitlab-development-kit

MIT

Pipeline 2958343473 with its jobs and its trigger jobs

tests/data/Runs/GitLabRunner.json

gitlab-org/gitlab-runner

MIT

Application Testing (Optional)

Additional Python packages needed for testing the program pytooling-gitlab as installed. 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

colorama

≥0.4

BSD 3-Clause Revised License

none

matplotlib

≥3.10

Python Software Foundation License 2.0

pytest

≥9.1

MIT License

pytest-xdist

≥3.8

MIT License

pyTooling

≥10.0

Apache License 2.0

none

ruamel.yaml

≥0.19

MIT License

none

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

docutils_stubs

≥0.0

The Unlicense

pyTooling

≥10.0

Apache License 2.0

none

pyTooling.Sphinx

≥0.1

Apache License 2.0

ruamel.yaml

≥0.19

MIT License

none

sphinx

≥9.1

BSD 2-Clause Simplified License

sphinx_autodoc_typehints

≥3.13

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