Unified SDK for OpenStack
Go to file
Brian Curtin d299da56cf 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
2015-02-11 10:25:48 -06:00
doc Provide a better default user-agent string 2015-02-08 09:57:48 -06:00
examples Allow examples.get call without data 2015-01-31 22:46:21 -06:00
openstack Merge "Add status_code to HttpException" 2015-02-09 16:13:47 +00:00
.coveragerc setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
.gitignore Add .venv to .gitignore 2014-04-21 09:31:52 -06:00
.gitreview Made tox -e pep8 passed. Also made git review work 2014-01-28 09:20:44 -08:00
.mailmap setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
.testr.conf setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
HACKING.rst setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
LICENSE setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
MANIFEST.in setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
README.rst Update README and setup text for PyPI 2015-02-11 10:25:48 -06:00
babel.cfg setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
openstack-common.conf Use the now graduated oslo.utils 2014-10-07 12:00:57 -07:00
requirements.txt Add six to requirements 2015-02-02 19:56:56 -06:00
setup.cfg Update README and setup text for PyPI 2015-02-11 10:25:48 -06:00
setup.py Synced from global-requirements 2014-06-16 14:03:30 -07:00
test-requirements.txt Updated from global requirements 2014-11-20 14:13:33 +00:00
tox.ini Remove flake/pep8 ignores 2015-01-26 12:27:53 -07:00

README.rst

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