Files

Victoria Martínez de la Cruz 057dad13a3 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

2014-07-31 11:12:12 -03:00

2.6 KiB

Raw Blame History

Python Marconi Client

version: 0.1.0
Wiki: Marconi Wiki
Launchpad: Marconi Launchpad
Review: Code Review
Design: Client Wiki
IRC: #openstack-marconi @ freenode

Welcome to the Marconi Python Client project!

Table of Contents

Installation

The latest stable release can be installed from PyPI:

pip install --upgrade python-marconiclient

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.

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

Contributing

Be sure to reference the HACKING file for details on coding style. You may also wish to read through Marconi's Contributor Guide before contributing your first patch.

2.6 KiB Raw Blame History