~tripleo/python-tuskarclient/master

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Matt Wagner
  • Date: 2013-08-23 18:32:40 UTC
  • Revision ID: git-v1:896ae5abddb7d969432692dd0b908d62d2205b86
Populates README file

Replaces the blank README with a quick introduction, as well as
tips on getting started and using it.

Change-Id: I175822ccb046236de500a5a918b2f2337b692201

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
===================
 
2
python-tuskarclient
 
3
===================
 
4
 
 
5
python-tuskarclient is a Python client for `Tuskar <https://github.com/stackforge/tuskar>`_, which also implements a command-line interface.
 
6
 
 
7
 
 
8
Getting Started
 
9
===============
 
10
 
 
11
Clone the repo::
 
12
 
 
13
    $ git clone git@github.com:tuskar/python-tuskarclient.git
 
14
 
 
15
Then, use ``tox`` to set up a virtual environment and run tests::
 
16
 
 
17
    $ cd python-tuskarclient
 
18
    $ tox
 
19
 
 
20
When this is done, activate your virtual environment::
 
21
 
 
22
    $ source .tox/py27/bin/activate
 
23
 
 
24
Finally, use this script to build the wrapper script in your virtual environment for the CLI tools::
 
25
 
 
26
    $ python setup.py develop
 
27
 
 
28
 
 
29
Use from Python
 
30
===============
 
31
 
 
32
For using ``python-tuskarclient`` within a Python application,
 
33
`this wiki page <https://github.com/tuskar/python-tuskarclient/wiki/Usage>`_ provides
 
34
the most complete documentation.
 
35
 
 
36
Use from the CLI
 
37
================
 
38
 
 
39
On the command line, ``python-tuskarclient`` implements the ``tuskar`` command.
 
40
 
 
41
First, be sure to run all of the steps in the Getting Started section, above, and that you have not deactivated your virtual environment.
 
42
 
 
43
Then, export these two environment variables, customizing them if necessary::
 
44
 
 
45
    $ export OS_AUTH_TOKEN=nopass
 
46
    $ export TUSKAR_URL=http://localhost:6385/
 
47
 
 
48
(Note that 'nopass' is the correct value in a default setup with no authentication.)
 
49
 
 
50
Now you may interact with Tuskar by using the ``tuskar`` command. ``tuskar --help`` with list full usage details. You can use ``tuskar rack-list`` as an example.
 
 
b'\\ No newline at end of file'