Unified SDK for OpenStack
Go to file
Brian Curtin f51162070c Make end-user modules accessible from top level
There are several modules that end-users are expected to be
using--connection, profile, exceptions, and utils--which could be made
slightly more accessible by having them available in the top level
`openstack` namespace. This change proposes importing `from openstack
import <x>` in openstack.__init__.py so that end-users can do `import
openstack` and then work from there.

Nothing more than the typical end-user entry points are to be exposed
from there, so if you need to get the server resource you still need
to do `from openstack.compute.v2 import server`. Additionally, we should
continue documenting and using in tests everything in the `from
openstack import <x>` format ourselves as this is merely a convenience.

Change-Id: I24a7ce3636b18287fcb2246fbdfa9f8b6767f323
2016-07-22 13:21:06 -04:00
doc Merge "Add neutron rbac support" 2016-06-29 14:40:39 +00:00
examples Merge "Cluster user guide - part 2" 2016-06-06 09:19:29 +00:00
openstack Make end-user modules accessible from top level 2016-07-22 13:21:06 -04:00
.coveragerc Fix coverage configuration and execution 2016-03-14 07:34:53 +00:00
.gitignore add .eggs to .gitignore 2015-07-18 09:55:48 -06:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:37:27 +00:00
.mailmap setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
.testr.conf Basic object store container functional tests 2015-05-13 13:52:04 +00:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
HACKING.rst Minor changes to top level docs 2015-05-22 17:19:16 -07: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 Remove requests from requirements 2015-12-16 14:51:40 -06:00
babel.cfg setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
create_yaml.sh Create clouds.yaml for functional tests 2015-05-30 12:30:36 -06:00
docs-requirements.txt Add requirements.txt file for readthedocs 2015-05-21 08:16:44 -07:00
post_test_hook.sh Fix post test hook script 2015-12-09 07:24:37 -07:00
requirements.txt Updated from global requirements 2016-07-17 23:59:49 +00:00
setup.cfg remove python 2.6 trove classifier 2015-12-23 01:31:15 +00:00
setup.py Updated from global requirements 2015-09-21 14:44:17 +00:00
test-requirements.txt Updated from global requirements 2016-07-21 13:44:02 +00:00
tox.ini Remove openstack/common from tox.ini 2016-04-25 06:18:52 -05: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",
                             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