3710127a5f
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: b'https://gist.github.com/86c7e945bcedfb376784ec3a4ecd6356\n' Change-Id: Ie110ff1a82611e1c0efcade9cff243c094211804
73 lines
2.1 KiB
ReStructuredText
73 lines
2.1 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/python-karborclient.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
Karbor
|
|
======
|
|
|
|
.. image:: https://img.shields.io/pypi/v/python-karborclient.svg
|
|
:target: https://pypi.python.org/pypi/python-karborclient/
|
|
:alt: Latest Version
|
|
|
|
.. image:: https://img.shields.io/pypi/dm/python-karborclient.svg
|
|
:target: https://pypi.python.org/pypi/python-karborclient/
|
|
:alt: Downloads
|
|
|
|
|
|
Karbor Mission Statement
|
|
|
|
* Formalize Application Data Protection in OpenStack (APIs, Services, Plugins, …)
|
|
* Be able to protect Any Resource in OpenStack(as well as their dependencies)
|
|
* Allow Diversity of vendor solutions, capabilities and implementations
|
|
without compromising usability
|
|
|
|
* `PyPi`_ - package installation
|
|
* `Launchpad project`_ - release management
|
|
* `Blueprints`_ - feature specifications
|
|
* `Bugs`_ - issue tracking
|
|
* `Source`_
|
|
* `Specs`_
|
|
* `How to Contribute`_
|
|
|
|
.. _PyPi: https://pypi.python.org/pypi/python-karborclient
|
|
.. _Launchpad project: https://launchpad.net/python-karborclient
|
|
.. _Blueprints: https://blueprints.launchpad.net/python-karborclient
|
|
.. _Bugs: https://bugs.launchpad.net/python-karborclient
|
|
.. _Source: https://git.openstack.org/cgit/openstack/python-karborclient
|
|
.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
|
|
|
|
|
|
Python Karborclient
|
|
-------------------
|
|
python-karborclient is a client library for karbor built on the karbor API.
|
|
It provides a Python API (the ``karborclient`` module) and a command-line tool
|
|
(``karbor``).
|
|
Project Resources
|
|
-----------------
|
|
|
|
Project status, bugs, and blueprints are tracked on Launchpad:
|
|
|
|
* Client bug tracker
|
|
* https://launchpad.net/python-karborclient
|
|
|
|
* Karbor bug tracker
|
|
* https://launchpad.net/karbor
|
|
|
|
Developer documentation can be found here:
|
|
|
|
http://docs.openstack.org/developer/karbor
|
|
|
|
Additional resources are linked from the project wiki page:
|
|
|
|
https://wiki.openstack.org/wiki/karbor
|
|
|
|
License
|
|
-------
|
|
|
|
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
|