59561d21e6
The HACKING file is taken almost verbatim from marconi. The README adds many useful resources: links to Wiki, more prominent version number, link to HACKING guide. The setup.py's copyright year has been bumped (2010 -> 2013). Change-Id: I6385c54ca09321d4a7e26f5821b9a4323264891b
44 lines
1.2 KiB
ReStructuredText
44 lines
1.2 KiB
ReStructuredText
*********************
|
|
Python Marconi Client
|
|
*********************
|
|
|
|
:version: 0.1.0
|
|
:Wiki: `Marconi Wiki`_
|
|
:Trello: `Marconi Trello`_
|
|
:Review: `Code Review`_
|
|
:Design: `Client Wiki`_
|
|
:IRC: #openstack-marconi @ freenode
|
|
|
|
Welcome to the `Marconi`_ Client Python bindings project!
|
|
|
|
**Table of Contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
:backlinks: none
|
|
|
|
============
|
|
Installation
|
|
============
|
|
|
|
Until this project is on `PyPi`_, the official way to install these bindings are to::
|
|
|
|
pip install git+https://github.com/cabrera/python-marconiclient.git
|
|
|
|
============
|
|
Contributing
|
|
============
|
|
|
|
The primary maintainer of this project is: TBA
|
|
|
|
Be sure to reference the `HACKING`_ file for all the details.
|
|
|
|
.. _Marconi: https://github.com/stackforge/marconi
|
|
.. _PyPi: https://pypi.python.org
|
|
.. _HACKING: https://github.com/stackforge/python-marconiclient/tree/master/HACKING.rst
|
|
.. _Marconi Wiki: https://wiki.openstack.org/wiki/Marconi
|
|
.. _Marconi Trello: https://trello.com/board/openstack-marconi/511403287d138cd6200078e0
|
|
.. _Code Review: https://review.openstack.org/#/q/status:open+project:stackforge/python-marconiclient,n,z
|
|
.. _Client Wiki: https://wiki.openstack.org/wiki/Python_Marconi_Client
|