Contributing

Thought of something you would like to see in Bastio Agent? This document will help you get started.

Important URLs

Bastio Agent uses git to track code history and hosts its code repository at github. The issue tracker is where you can file bug reports and request features or enhancements to Bastio Agent. We also have a PyPI repository hosted at PyPI, and a PPA repository. Bastio Agent uses and is centered around Paramiko.

Before You Start

Ensure your system has the following programs and libraries installed:

• Python
• git
• ssh
• virtualenv

Setting up the Work Environment

• Fork the code repository into your github account. Let us call you hackeratti for the sake of this example. Replace hackeratti with your own username below.

• Clone your fork and setup your environment:

  $ git clone git@github.com:hackeratti/bastio-agent.git
  $ cd bastio-agent/
  $ virtualenv venv/
  $ source venv/bin/activate
  $ pip install -r requirements.txt
  $ python setup.py develop

Note

Run python setup.py develop only once at first, any changes won’t affect the script generated in the venv/bin directory.