Update README and setup text for PyPI

This change updates the README text that shows up on PyPI so we can get
a small example up there as well as the documentation link. It also
marks 3.4 as supported, since we've been testing that for a while now.

Change-Id: I28555eb4e121f35151afc8548adb3df166257814
Closes-Bug: 1420858
This commit is contained in:
Brian Curtin
2015-02-11 10:24:31 -06:00
parent 5619dec11e
commit d299da56cf
2 changed files with 26 additions and 22 deletions

View File

@@ -1,32 +1,34 @@
OpenStack Python SDK
====================
``python-openstacksdk`` is a new Python library and SDK for OpenStack
clouds. It is very young, and not yet usable, but it's under active
development.
The ``python-openstacksdk`` is a collection of libraries for building
applications to work with OpenStack clouds. The project aims to provide
a consistent and complete set of interactions with OpenStack's many
services, along with complete documentation, examples, and tools.
Our goal is to provide a Python library which is:
This SDK is under active development, and in the interests of providing
a high-quality interface, the APIs provided in this release may differ
from those provided in future release.
* Pleasant to use
* Well documented
* Complete (works with any OpenStack project)
Usage
-----
Building Documentation
----------------------
The following example simply connects to an OpenStack cloud and lists
the containers in the Object Store service.::
This documentation is written by contributors, for contributors.
from openstack import connection
conn = connection.Connection(auth_url="http://openstack:5000/v3",
project_name="big_project",
user_name="SDK_user",
password="Super5ecretPassw0rd")
for container in conn.object_store.containers():
print(container.name)
The source is maintained in the ``doc/source/`` folder using
`reStructuredText`_ and built by `Sphinx`_
Documentation
-------------
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/
To build the docs locally::
$ python setup.py build_sphinx
Results are in the ``doc/build/html/`` directory.
Documentation is available at
http://python-openstacksdk.readthedocs.org/en/latest/
Requirements
------------
@@ -34,8 +36,9 @@ Requirements
* Python 2.6+, Python 3.3+
* pbr
* requests
* iso8601
* six
* stevedore
* oslo.utils
License
-------

View File

@@ -1,6 +1,6 @@
[metadata]
name = python-openstacksdk
summary = OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package.
summary = An SDK for building applications to work with OpenStack
description-file =
README.rst
author = OpenStack
@@ -18,6 +18,7 @@ classifier =
Programming Language :: Python :: 2.6
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.4
[files]
packages =