← Back to branch summary

~tripleo/python-tuskarclient/master

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Gerrit Code Review
  • Author(s): Jenkins
  • Date: 2013-08-26 14:38:14 UTC
  • mfrom: (34.1.1)
  • Revision ID: git-v1:e3eb26281f9a5428a03c122a224c8365c92a32c2
Merge "A few tweaks for readme"

Show diffs side-by-side

added added

removed removed

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