Working with the Source¶
Setting up a Development Sandbox¶
Set up a server or virtual machine.
Clone the kwapi project to the machine:
$ git clone https://github.com/grid5000/kwapi-g5k.git $ cd ./kwapi-g5k
Once this is done, use install option of setup.py file to install kwapi locally:
$ python setup.py install
If some dependant packages are missing, fix them with pip install:
$ pip install -r requirements.txt
You can start to hack kwapi. If you are preparing a patch, create a topic branch and switch to it before making any changes:
$ git checkout -b TOPIC-BRANCH
Use git to push your changes and ask for a pull request.
Package your solution for Debian installation:
$ python setup.py --command-packages=stdeb.command bdist_deb $ cd deb_dist/
All the deb archives are exported in this directory.
Import the new generated packages of kwapi-g5k on the remote apt repository.
Execute Puppet on the VM to install the latest version of Kwapi or simply run:
$ apt-get update && apt-get install python-kwapi-g5k
Kwapi uses the GitHub to hos all code and developer documentation contributions. You can report an issue or a feature request on this repository.
Bugzilla can also be used for API related bugs or device configuration problems.