2017-06-28 14:48:50 +02:00
|
|
|
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::
|
|
|
|
|
|
|
|
|
|
$ sudo pip3 install -e .
|
|
|
|
|
|
|
|
|
|
That will install a backlink /usr/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>
|
|
|
|
|
|
|
|
|
|
to the call.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Community Resources
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
Project home:
|
|
|
|
|
|
|
|
|
|
- https://github.com/siemens/kas
|
|
|
|
|
|
|
|
|
|
Source code:
|
|
|
|
|
|
|
|
|
|
- https://github.com/siemens/kas.git
|
|
|
|
|
- git@github.com:siemens/kas.git
|
|
|
|
|
|
2017-06-28 16:22:36 +02:00
|
|
|
Documentation:
|
|
|
|
|
|
|
|
|
|
- https://kas.readthedocs.org
|
|
|
|
|
|
2017-06-28 14:48:50 +02:00
|
|
|
Mailing list:
|
|
|
|
|
|
|
|
|
|
- kas-devel@googlegroups.com
|
|
|
|
|
|
|
|
|
|
- Subscription:
|
|
|
|
|
|
|
|
|
|
- kas-devel+subscribe@googlegroups.com
|
|
|
|
|
- https://groups.google.com/forum/#!forum/kas-devel/join
|
|
|
|
|
|
|
|
|
|
- Archives
|
|
|
|
|
|
|
|
|
|
- https://groups.google.com/forum/#!forum/kas-devel
|
|
|
|
|
- https://www.mail-archive.com/kas-devel@googlegroups.com/
|
|
|
|
|
|
|
|
|
|
Class reference documentation
|
|
|
|
|
-----------------------------
|
|
|
|
|
|
|
|
|
|
``kas.kas`` Module
|
|
|
|
|
..................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.kas
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.libkas`` Module
|
|
|
|
|
.....................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.libkas
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.libcmds`` Module
|
|
|
|
|
......................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.libcmds
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.build`` Module
|
|
|
|
|
....................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.build
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.shell`` Module
|
|
|
|
|
....................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.shell
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.config`` Module
|
|
|
|
|
.....................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.config
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.repos`` Module
|
|
|
|
|
....................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.repos
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
``kas.includehandler`` Module
|
|
|
|
|
.............................
|
|
|
|
|
|
|
|
|
|
.. automodule:: kas.includehandler
|
|
|
|
|
:members:
|
|
|
|
|
|
