swaprcli - GatechVIP/gatech-swapr-provisioning GitHub Wiki

Overview

swaprcli is a special Python command line tool for managing and developing SWAPR. It is written using the cement Python library for designing CLI tools.

Installing swaprcli dependencies

swaprcli is written in and for Python 3, and has not been tested for use with Python 2.

swaprcli can be used without installing, but it has dependencies that need to be added to your global Python packages.

To install these dependencies, run from the swaprcli directory:

pip install -Ur requirements.txt

Using swaprcli

Once dependencies are installed, swaprcli can be used from the provisioning directory:

python -m swaprcli

The help for swaprcli is comprehensive and includes all functionality.

Contributing

Coming soon! Read the cement docs and think of commands that are run often that we could benefit from turning into a command on swaprcli.