openstacksdk/README.rst
Brian Curtin 27f044df4f Remove requests from requirements
With the move to keystoneauth, we no longert depend on the requests
library for anything at runtime. We do still have one test, which is
valid, that depends on requests to ensure that
https://bugs.launchpad.net/python-openstacksdk/+bug/1428342 stays fixed.
This change moves requests to test-requirements and additionally removes
the list of dependencies in the README file, as it duplicates the only
place requirements are truly needed.

Change-Id: I6aa8e71573e685b2748150ea5cec946b65d525ae
2015-12-16 14:51:40 -06:00

37 lines
1.1 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",
username="SDK_user",
password="Super5ecretPassw0rd")
for container in conn.object_store.containers():
print(container.name)
Documentation
-------------
Documentation is available at
http://developer.openstack.org/sdks/python/openstacksdk/
License
-------
Apache 2.0