d299da56cf
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
47 lines
1.2 KiB
ReStructuredText
47 lines
1.2 KiB
ReStructuredText
OpenStack Python SDK
|
|
====================
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
Usage
|
|
-----
|
|
|
|
The following example simply connects to an OpenStack cloud and lists
|
|
the containers in the Object Store service.::
|
|
|
|
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)
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Documentation is available at
|
|
http://python-openstacksdk.readthedocs.org/en/latest/
|
|
|
|
Requirements
|
|
------------
|
|
|
|
* Python 2.6+, Python 3.3+
|
|
* pbr
|
|
* requests
|
|
* six
|
|
* stevedore
|
|
* oslo.utils
|
|
|
|
License
|
|
-------
|
|
|
|
Apache 2.0
|