diff options
| author | Angus Salkeld <asalkeld@redhat.com> | 2013-10-29 20:37:50 +1100 |
|---|---|---|
| committer | Angus Salkeld <asalkeld@redhat.com> | 2013-10-29 21:59:46 +1100 |
| commit | ed81b3ad2429c87f9e71b6e7bed0193638d0a48c (patch) | |
| tree | 09b3de93613ed3258605d0799f661558b6ccf950 /doc | |
| parent | 3204ead19f7f9d7701e2223e609b1351407e19bf (diff) | |
| download | python-heatclient-ed81b3ad2429c87f9e71b6e7bed0193638d0a48c.tar.gz | |
Add a top level introduction to the index
Change-Id: Icfe152a2829c2cb82a0955b91052183d7c488510
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/index.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index f1d8b4d..87f7a2d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,16 @@ +Python bindings to the OpenStack Heat API +========================================= + +This is a client for OpenStack Heat API. There's a Python API +(the :mod:`heatclient` module), and a command-line script +(installed as :program:`heat`). + Python API ========== In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:: >>> from heatclient import Client >>> heat = Client('1', endpoint=OS_IMAGE_ENDPOINT, token=OS_AUTH_TOKEN) -... - Command-line Tool ================= |