shade/doc/source/user/usage.rst
Sean McGinnis df4c5819d2 Remove redundant target in README
An 'example' anchor was being explicitly added that was
redundant with the 'Example' title it preceeded. This
causes failures with `python setup.py check -s -r` which
was added to release validation to prevent pypi package
upload failures.

Since the README is imported into the built docs, and the
docs link to the examples using this hidden anchor, this
renames it to avoid a conflict.

Change-Id: I6947e0ae420402cc9866e3c374626392b1d5194c
2018-07-19 19:52:02 -05:00

566 B

Usage

To use shade in a project:

import shade

For a simple example, see usage_example.

Note

API methods that return a description of an OpenStack resource (e.g., server instance, image, volume, etc.) do so using a munch.Munch object from the Munch library. Munch objects can be accessed using either dictionary or object notation (e.g., server.id, image.name and server['id'], image['name'])

shade.OpenStackCloud