shade/doc/source/usage.rst
David Shrewsbury 0f6203f303 Split out OpenStackCloud and OperatorCloud classes
Change-Id: If8a09f52313c07d12c7fe0da66f6599de3120979
2015-10-31 15:18:32 -04:00

21 lines
511 B
ReStructuredText

=====
Usage
=====
To use shade in a project::
import shade
.. warning::
Several of the API methods return a ``dict`` that describe a resource.
It is possible to access keys of the dict as an attribute (e.g.,
``server.id`` instead of ``server['id']``) to maintain some backward
compatibility, but attribute access is deprecated. New code should
assume a normal dictionary and access values via key.
.. autoclass:: shade.OpenStackCloud
:members:
.. autoclass:: shade.OperatorCloud
:members: