23 lines
615 B
ReStructuredText
23 lines
615 B
ReStructuredText
=====
|
|
Usage
|
|
=====
|
|
|
|
To use shade in a project::
|
|
|
|
import openstack.cloud
|
|
|
|
For a simple example, see :ref:`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 <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:: openstack.cloud.OpenStackCloud
|
|
:members:
|
|
|
|
.. autoclass:: openstack.cloud.OperatorCloud
|
|
:members:
|