shade/doc/source/usage.rst
David Shrewsbury e71bee318c Stop leaking server objects
We should not be returning raw client objects when creating or
rebuilding a server.

The usage document is updated to indicate that access to resource
values via attribute is deprecated, and the examples in the README
now reflect dict-style access.

Change-Id: Iac38d4c0b29f867cc3cefaccf48c1c3fcd17a3d9
2015-05-12 15:14:04 -04:00

18 lines
448 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.
.. automodule:: shade
:members: