be666ff985
This patch documents the basic usage of `Client` instances. It does not provide a detailed documentation about the methods exposed but a high level documentation of what the recommended way to access these resources is. The current version refers to sections like 'core API', 'config' and others that haven't been documented yet. Once they will be, proper links to those sections will be added here. Change-Id: I705498b8e4c19c75c9697419d1fd90c9a9ae40b9
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-zaqarclientFor the adventurous, you may also install the latest code directly from GitHub:
pip install git+https://github.com/openstack/python-zaqarclient.gitWhat'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 myqueueContributing
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.