openstack
/
python-cueclient
Code Issues Proposed changes
python-cueclient/doc/source/getting-started.rst

1.8 KiB
Raw Blame History

Getting Started

The python-cueclient can be used either as a command line tool or as a binding to access Cue.

Installing Cue Client from source

double: install; python-cueclient

  1. Clone the CueClient repo from GitHub
$ git clone https://github.com/openstack/python-cueclient.git
$ cd python-cueclient
  1. Setup virtualenv

Note

This is an optional step, but will allow CueClient's dependencies to be installed in a contained environment that can be easily deleted if you choose to start over or uninstall Cue.

$ virtualenv --no-site-packages .venv
$ . .venv/bin/activate
  1. Install CueClient and its dependencies
$ pip install -r requirements.txt -r test-requirements.txt
$ python setup.py develop

Installation to use as Command Line Tool

  1. To access the shell for cue client 'python-openstackclient' has to be installed.
$ pip install python-openstackclient

Note

This step can be skipped if you choose to use python-cueclient as only a binding to Cue API.