shade/doc/source/usage.rst
Monty Taylor 9cdd967550
Go ahead and admit that we return Munch objects
There was a point in time in the past where we were gung ho on using
Munch as a halfway house to get us to pure dicts. However, we released
1.0 before we could do that, so we're pretty stuck with them for the
forseeable future. That's not terrible - they're pretty low overhead and
work pretty well.

Depends-On: Ie10099430481ffa76f5a19557e3693189544df6b
Change-Id: I8b7dd2c4038db999280ec0c2c9c43fb9499e6d22
2016-08-03 08:16:54 -05:00

21 lines
542 B
ReStructuredText

=====
Usage
=====
To use shade in a project::
import shade
.. 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 <https://github.com/Infinidat/munch>`_. `Munch`
objects can be accessed using either dictionary or object notation
(e.g., ``server.id``, ``image.name`` and ``server['id']``, ``image['name']``)
.. autoclass:: shade.OpenStackCloud
:members:
.. autoclass:: shade.OperatorCloud
:members: