Based on the desgin of openstack client, the docstring of each function will be the help string for cli. Now all the other services' commands don't use a period. So let's remove them for zaqar to be consistent. Change-Id: I9c8b18995c311d844a25c4a4da6be1aa6cc3790b
Python Zaqar Client
- version
-
0.1.0
- Wiki
- Launchpad
- Review
- Design
- IRC
-
#openstack-zaqar @ freenode
Welcome to the Zaqar Python Client project!
Table of Contents
Installation
The latest stable release can be installed from PyPI:
pip install --upgrade python-zaqarclient
For the adventurous, you may also install the latest code directly from GitHub:
pip install git+https://github.com/openstack/python-zaqarclient.git
What's in the box
By installing python-zaqarclient you get programmatic access to the Zaqar 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.
Command line interface
Zaqar 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
Contributing
Be sure to reference the HACKING file for details on coding style. You may also wish to read through Zaqar's Contributor Guide before contributing your first patch.