Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 2.71 KB

devguide.rst

File metadata and controls

130 lines (82 loc) · 2.71 KB

Developer Guide

Deploy for development

This project uses pip to manage the package. If you want to work on the project yourself you can create the necessary links via:

$ pip3 install --user -e .

That will install a backlink ~/.local/bin/kas to this project. Now you are able to call it from anywhere.

Container image build

To build the container images kas provides, there is a script provided for your convenience. It uses docker buildx and requires BuildKit 0.13.0 or newer. To start the build both container variants, invoke:

$ scripts/build-container.sh

You can limit the target type to either Yocto/OE (kas) or isar (kas-isar) via the --target options. See the script help for more options.

Since release 4.3, the containers officially provided via ghcr.io are fully reproducible. To test this, you can use the following script, e.g. to validate that release:

$ scripts/reproduce-container.sh kas:4.3

Both scripts also support building/checking of the arm64 container images. See the help of both scripts for more details.

Measure code coverage

To measure the code coverage of the unit tests, the pytest-cov package is required. On Debian systems, this is provided in python3-pytest-cov. Once installed, run:

$ python3 -m pytest --cov --cov-report html

The coverage in HTML format can then be found in htmlcov.

Community Resources

Project home:

Source code:

Documentation:

Mailing list:

Class reference documentation

kas.kas Module

kas.kas

kas.libkas Module

kas.libkas

kas.libcmds Module

kas.libcmds

kas.config Module

kas.config

kas.repos Module

kas.repos

kas.includehandler Module

kas.includehandler

kas.kasusererror Module

kas.kasusererror

kas.plugins Module

kas.plugins