openstack
/
python-heatclient
Code Issues Proposed changes

Add a top level introduction to the index 

Change-Id: Icfe152a2829c2cb82a0955b91052183d7c488510
This commit is contained in:
Angus Salkeld 2013-10-29 20:37:50 +11:00
parent 3204ead19f
commit ed81b3ad24
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/index.rst
View File

@ -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
=================