Improve docs
Change-Id: I4894254605a2b9ca29c59beec13bd4f02692bcb8
This commit is contained in:
parent
8344d16ec9
commit
2107e7bfc1
@ -11,6 +11,8 @@ Requirements
|
|||||||
Instructions
|
Instructions
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
We strongly encourage tu use a virtual environment to install the software: :code:`python3 -m venv my_virtual_env`.
|
||||||
|
|
||||||
At the command line::
|
At the command line::
|
||||||
|
|
||||||
$ pip install python-almanachclient
|
$ pip install python-almanachclient
|
||||||
|
@ -15,14 +15,14 @@ First, create an Almanach Client instance with your credentials::
|
|||||||
>>> almanach = Client(ALMANACH_URL, AUTH_TOKEN)
|
>>> almanach = Client(ALMANACH_URL, AUTH_TOKEN)
|
||||||
|
|
||||||
Here ``ALMANACH_URL`` will be a string that represents the url of Almanach API.
|
Here ``ALMANACH_URL`` will be a string that represents the url of Almanach API.
|
||||||
``AUTH_TOKEN`` will be the authorization token you use to acces the API.
|
``AUTH_TOKEN`` will be the authorization token you use to access the API.
|
||||||
|
|
||||||
|
|
||||||
You can also create a Keystone Client instance and access the API with it::
|
You can also create a Keystone Client instance to fetch Almanach API endpoint::
|
||||||
|
|
||||||
>>> from almanachclient.keystone_client import KeystoneClient
|
>>> from almanachclient.keystone_client import KeystoneClient
|
||||||
>>> keystone_client = KeystoneClient(KEYSTONE_URL, USERNAME, PASSWORD, SERVICE, REGION)
|
>>> keystone_client = KeystoneClient(KEYSTONE_URL, USERNAME, PASSWORD, SERVICE, REGION)
|
||||||
>>> almanach_url = keystone_client.get_endpoint_url('admin')
|
>>> almanach_url = keystone_client.get_endpoint_url()
|
||||||
|
|
||||||
In this case ``KEYSTONE_URL`` will be a string that represents the url of your keystone catalog.
|
In this case ``KEYSTONE_URL`` will be a string that represents the url of your keystone catalog.
|
||||||
The nature of ``USERNAME`` and ``PASSWORD`` speak for themselves. ``SERVICE`` will be a string
|
The nature of ``USERNAME`` and ``PASSWORD`` speak for themselves. ``SERVICE`` will be a string
|
||||||
|
@ -52,7 +52,7 @@ Usage: :code:`almanach list-entities <tenant_id> <start> --end <end>`
|
|||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
almanach list-entities bca89ae64dba46b8b74653d8d9ae8364 2016-01-01 2017-05-30
|
almanach list-entities bca89ae64dba46b8b74653d8d9ae8364 2016-01-01 --end 2017-05-30
|
||||||
|
|
||||||
+--------------------------------------+----------+--------+---------------------------+------+---------------------------------------------------------------------------------------+
|
+--------------------------------------+----------+--------+---------------------------+------+---------------------------------------------------------------------------------------+
|
||||||
| Entity ID | Type | Name | Start | End | Properties |
|
| Entity ID | Type | Name | Start | End | Properties |
|
||||||
|
Loading…
x
Reference in New Issue
Block a user