x/python-tuskarclient
Code Issues Proposed changes

A few tweaks for readme

Browse Source 
* Reword the intro sentence to make CLI sound equally important as
  Python client :)

* Change clone url from tuskar org to stackforge org and change it to
  https, because ssh cloning requires the user to have a Github
  account.

* Format paragraphs to keep line length under 72 chars.

Change-Id: I07ab9a89076153691b75ba40aa569c59284e84dc
This commit is contained in:
Jiri Stransky 2013-08-26 12:56:16 +02:00
parent bf2f35506c
commit f84f2936d5
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@ -2,7 +2,8 @@
python-tuskarclient python-tuskarclient
=================== ===================
python-tuskarclient is a Python client for `Tuskar <https://github.com/stackforge/tuskar>`_, which also implements a command-line interface. python-tuskarclient is a Python client and a command-line interface
for `Tuskar <https://github.com/stackforge/tuskar>`_.
Getting Started Getting Started
@ -10,7 +11,7 @@ Getting Started
Clone the repo:: Clone the repo::
$ git clone git@github.com:tuskar/python-tuskarclient.git $ git clone https://github.com/stackforge/python-tuskarclient.git
Then, use ``tox`` to set up a virtual environment and run tests:: Then, use ``tox`` to set up a virtual environment and run tests::
@ -21,7 +22,8 @@ When this is done, activate your virtual environment::
$ source .tox/py27/bin/activate $ source .tox/py27/bin/activate
Finally, use this script to build the wrapper script in your virtual environment for the CLI tools:: Finally, use this script to build the wrapper script in your virtual
environment for the CLI tools::
$ python setup.py develop $ python setup.py develop
@ -29,22 +31,28 @@ Finally, use this script to build the wrapper script in your virtual environment
Use from Python Use from Python
=============== ===============
For using ``python-tuskarclient`` within a Python application, For using ``python-tuskarclient`` within a Python application, `this
`this wiki page <https://github.com/tuskar/python-tuskarclient/wiki/Usage>`_ provides wiki page <https://github.com/tuskar/python-tuskarclient/wiki/Usage>`_
the most complete documentation. provides the most complete documentation.
Use from the CLI Use from the CLI
================ ================
On the command line, ``python-tuskarclient`` implements the ``tuskar`` command. On the command line, ``python-tuskarclient`` implements the ``tuskar``
command.
First, be sure to run all of the steps in the Getting Started section, above, and that you have not deactivated your virtual environment. First, be sure to run all of the steps in the Getting Started section,
above, and that you have not deactivated your virtual environment.
Then, export these two environment variables, customizing them if necessary:: Then, export these two environment variables, customizing them if
necessary::
$ export OS_AUTH_TOKEN=nopass $ export OS_AUTH_TOKEN=nopass
$ export TUSKAR_URL=http://localhost:6385/ $ export TUSKAR_URL=http://localhost:6385/
(Note that 'nopass' is the correct value in a default setup with no authentication.) (Note that 'nopass' is the correct value in a default setup with no
authentication.)
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. 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.