add escalator cli framework

JIRA:ESCALATOR-36

This patch will support escalatorclient,and this is just the frame of
escalatorclient,with this code you can use 'python setup.py sdist' to
generate escalatorclient package.

Change-Id: Id7b602345f7cb78bb548b589d1297a201056699a
Signed-off-by: Zhou Ya <zhou.ya@zte.com.cn>

1 files changed, 37 insertions, 0 deletions

diff --git a/client/doc/source/index.rst b/client/doc/source/index.rst
new file mode 100644
index 0000000..ec7d4ef
--- /dev/null
+++ b/client/doc/source/index.rst
@@ -0,0 +1,37 @@
+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 escalatorclient import Client
+    >>> escalator = Client('1', endpoint=OS_IMAGE_ENDPOINT, token=OS_AUTH_TOKEN)
+    >>> image = escalator.images.create(name="My Test Image")
+    >>> print image.status
+    'queued'
+    >>> image.update(data=open('/tmp/myimage.iso', 'rb'))
+    >>> print image.status
+    'active'
+    >>> image.update(properties=dict(my_custom_property='value'))
+    >>> with open('/tmp/copyimage.iso', 'wb') as f:
+            for chunk in image.data:
+                f.write(chunk)
+    >>> image.delete()
+
+For an API v2 example see also :doc:`apiv2`.
+
+Command-line Tool
+=================
+In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
+
+    export OS_USERNAME=user
+    export OS_PASSWORD=pass
+    export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+
+The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--os-image-url`` and ``--os-auth-token``. You can alternatively set these environment variables::
+
+    export OS_IMAGE_URL=http://escalator.example.org:9292/
+    export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
+
+Once you've configured your authentication parameters, you can run ``escalator help`` to see a complete listing of available commands.
+
+See also :doc:`/man/escalator`.
\ No newline at end of file