From 057dad13a315ce8a3e326470414dfcf49870f125 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Victoria=20Mart=C3=ADnez=20de=20la=20Cruz?= Date: Thu, 31 Jul 2014 11:12:12 -0300 Subject: [PATCH] Adds extra info about python-marconiclient and usage instructions Extends the readme with information about what is included in the python-marconiclient package and adds some usage instructions for the API (link to the existing wiki page) and the CLI Change-Id: I6c5a588d85af53237b3cb11bb9cc8b6e31472fd1 Closes-Bug: #1350867 --- README.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.rst b/README.rst index 1d0b328d..0211ccfa 100644 --- a/README.rst +++ b/README.rst @@ -30,6 +30,40 @@ For the adventurous, you may also install the latest code directly from GitHub:: pip install git+https://github.com/openstack/python-marconiclient.git +================= +What's in the box +================= + +By installing python-marconiclient you get programmatic access to the Marconi v1.0 API library. Plus, it installs a plugin to python-openstackclient that allows you to perform simple queue operations. + +========== +How to use +========== + +------------- +Python client +------------- + +Details about design, features, usage and workflow can be found in the `Python Client Wiki`_. + +.. _Python Client Wiki: https://wiki.openstack.org/wiki/Marconi/PythonClient + +---------------------- +Command line interface +---------------------- + +Marconi bases its client implementation in the `OpenStack Client`_. It can be installed and configured by following the instructions in `Getting Started`_ and `Configuration`_ in the OpenStack Client readme respectively. + +The CLI currently allows creation, removal and listing of queues. Some examples are: + + $ openstack queue list --limit 3 + $ openstack queue create myqueue + $ openstack queue delete myqueue + +.. _`OpenStack Client`: https://github.com/openstack/python-openstackclient +.. _`Getting Started`: https://github.com/openstack/python-openstackclient#getting-started +.. _`Configuration`: https://github.com/openstack/python-openstackclient#configuration + ============ Contributing ============