Installation

If you are developing Shrinkwrap or contributing to the project, install it in editable mode with development dependencies.

Clone the repository

git clone https://git.gitlab.arm.com/tooling/shrinkwrap.git
cd shrinkwrap

All the following command are within an active virtual environment (see Create a virtual environment).

pip install --upgrade pip
pip install -e ".[dev]"

This installs Shrinkwrap in editable mode along with additional dependencies required for development, testing, and packaging.

To build the documentation locally, install the documentation dependencies:

pip install -e ".[docs]"

If you are both developing the code and building documentation, install both extras together:

pip install -e ".[dev,docs]"

Note

Editable installs reflect changes in the source tree immediately. There is no need to reinstall after modifying the code or documentation.

To build and generate the documentation in html format, run (inside the virtual environment):

sphinx-build -b html -a -W documentation public

To render and explore the documentation, simply open public/index.html in a web browser.