From 2107e7bfc15d76ed3b8a0327281624a7d700d5cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Guillot?= Date: Fri, 2 Jun 2017 14:02:31 -0400 Subject: [PATCH] Improve docs Change-Id: I4894254605a2b9ca29c59beec13bd4f02692bcb8 --- doc/source/installation.rst | 2 ++ doc/source/usage_api.rst | 6 +++--- doc/source/usage_cli.rst | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 96d6840..8c6b0bb 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -11,6 +11,8 @@ Requirements Instructions ------------ +We strongly encourage tu use a virtual environment to install the software: :code:`python3 -m venv my_virtual_env`. + At the command line:: $ pip install python-almanachclient diff --git a/doc/source/usage_api.rst b/doc/source/usage_api.rst index 5562596..71c93d3 100644 --- a/doc/source/usage_api.rst +++ b/doc/source/usage_api.rst @@ -15,14 +15,14 @@ First, create an Almanach Client instance with your credentials:: >>> almanach = Client(ALMANACH_URL, AUTH_TOKEN) 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 >>> 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. The nature of ``USERNAME`` and ``PASSWORD`` speak for themselves. ``SERVICE`` will be a string diff --git a/doc/source/usage_cli.rst b/doc/source/usage_cli.rst index a444f1e..91b2110 100644 --- a/doc/source/usage_cli.rst +++ b/doc/source/usage_cli.rst @@ -52,7 +52,7 @@ Usage: :code:`almanach list-entities --end ` .. 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 |