openstacksdk/README.rst
Terry Howe ecda673ca1 Resolve Ed's concerns on README
https://review.openstack.org/#/c/96253/4/README.rst

Change-Id: I8fbc39c0311baa193862b7ca06ee06b2fbd0a85f
2014-06-06 15:30:34 -06:00

871 B

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.

Our goal is to provide a Python library which is:

  • Pleasant to use
  • Well documented
  • Complete (works with any OpenStack project)

Building Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the doc/source/ folder using reStructuredText and built by Sphinx

To build the docs locally:

$ python setup.py build_sphinx

Results are in the doc/build/sphinx/html/ directory.

Requirements

  • Python 2.6+, Python 3.3+
  • pbr
  • requests

License

Apache 2.0