From f84f2936d5041d1c3b2d44b109978c6fe5ac256d Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Mon, 26 Aug 2013 12:56:16 +0200 Subject: [PATCH] A few tweaks for readme * 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 --- README.rst | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 818c463..cf65a3d 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,8 @@ python-tuskarclient =================== -python-tuskarclient is a Python client for `Tuskar `_, which also implements a command-line interface. +python-tuskarclient is a Python client and a command-line interface +for `Tuskar `_. Getting Started @@ -10,7 +11,7 @@ Getting Started 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:: @@ -21,7 +22,8 @@ When this is done, activate your virtual environment:: $ 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 @@ -29,22 +31,28 @@ Finally, use this script to build the wrapper script in your virtual environment Use from Python =============== -For using ``python-tuskarclient`` within a Python application, -`this wiki page `_ provides -the most complete documentation. +For using ``python-tuskarclient`` within a Python application, `this +wiki page `_ +provides the most complete documentation. 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 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. \ No newline at end of file +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.