f2d8a7fcf9
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/5c6ff379696d6744653a72a92c9b3bd8 Change-Id: Ia3d46379cdad604e7b2e0740b3fb57fbb67529c7
116 lines
3.4 KiB
ReStructuredText
116 lines
3.4 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/python-zaqarclient.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
*******************
|
|
Python Zaqar Client
|
|
*******************
|
|
|
|
.. image:: https://img.shields.io/pypi/v/python-zaqarclient.svg
|
|
:target: https://pypi.python.org/pypi/python-zaqarclient/
|
|
:alt: Latest Version
|
|
|
|
.. image:: https://img.shields.io/pypi/dm/python-zaqarclient.svg
|
|
:target: https://pypi.python.org/pypi/python-zaqarclient/
|
|
:alt: Downloads
|
|
|
|
:version: 0.1.0
|
|
:Wiki: `Zaqar Wiki`_
|
|
:Launchpad: `Zaqar Launchpad`_
|
|
:Review: `Code Review`_
|
|
:Design: `Client Wiki`_
|
|
:IRC: #openstack-zaqar @ freenode
|
|
|
|
Welcome to the `Zaqar`_ Python Client project!
|
|
|
|
**Table of Contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
:backlinks: none
|
|
|
|
============
|
|
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`_.
|
|
|
|
.. _Python Client Wiki: https://wiki.openstack.org/wiki/Zaqar/PythonClient
|
|
|
|
----------------------
|
|
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
|
|
|
|
.. _`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
|
|
============
|
|
|
|
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.
|
|
|
|
.. _Zaqar: https://github.com/openstack/zaqar
|
|
.. _HACKING: https://github.com/openstack/python-zaqarclient/tree/master/HACKING.rst
|
|
.. _Zaqar Wiki: https://wiki.openstack.org/wiki/Zaqar
|
|
.. _Contributor Guide: https://wiki.openstack.org/wiki/Zaqar#Contributor_Guide
|
|
.. _Zaqar Launchpad: https://launchpad.net/zaqar
|
|
.. _Code Review: https://review.openstack.org/#/q/status:open+project:openstack/python-zaqarclient,n,z
|
|
.. _Client Wiki: https://wiki.openstack.org/wiki/Python_Zaqar_Client
|
|
|
|
|
|
* License: Apache License, Version 2.0
|
|
* `PyPi`_ - package installation
|
|
* `Bugs`_ - issue tracking
|
|
* `Source`_
|
|
|
|
.. _PyPi: https://pypi.python.org/pypi/python-zaqarclient
|
|
.. _Bugs: https://bugs.launchpad.net/python-zaqarclient
|
|
.. _Source: https://git.openstack.org/cgit/openstack/python-zaqarclient
|
|
|