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.
Docker image build¶
Just run:
$ docker build -t <image_name> .
When you need a proxy to access the internet, add:
--build-arg http_proxy=<http_proxy> --build-arg https_proxy=<https_proxy> --build-arg ftp_proxy=<ftp_proxy> --build-arg no_proxy=<no_proxy>
to the call.
Community Resources¶
Project home:
Source code:
- https://github.com/siemens/kas.git
- git@github.com:siemens/kas.git
Documentation:
Mailing list:
Class reference documentation¶
kas.kas
Module¶
kas.libkas
Module¶
This module contains the core implementation of kas.
-
kas.libkas.
find_program
(paths, name)[source]¶ Find a file within the paths array and returns its path.
-
kas.libkas.
run_cmd
(cmd, cwd, env=None, fail=True, liveupdate=True)[source]¶ Runs a command synchronously.
kas.libcmds
Module¶
kas.build
Module¶
kas.shell
Module¶
kas.config
Module¶
kas.repos
Module¶
This module contains the Repo class.
-
class
kas.repos.
GitRepo
(url, path, refspec, layers, patches, disable_operations)[source]¶ Provides the git functionality for a Repo.
-
class
kas.repos.
MercurialRepo
(url, path, refspec, layers, patches, disable_operations)[source]¶ Provides the hg functionality for a Repo.
-
class
kas.repos.
Repo
(url, path, refspec, layers, patches, disable_operations)[source]¶ Represents a repository in the kas configuration.