summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-09-22 17:19:13 -0400
committerSteve Martinelli <stevemar@ca.ibm.com>2015-09-22 17:21:02 -0400
commit988e305b37e0f840ba09fdde882158641f8a1d05 (patch)
tree3174aa17adff5fc811721239d51a99704294298a
parent512d00e208190cd3d38ff275567633ff1dcdcf20 (diff)
downloados-client-config-988e305b37e0f840ba09fdde882158641f8a1d05.tar.gz
update RST for readme so pypi looks pretty
Navigating to https://pypi.python.org/pypi/os-client-config results in seeing the raw RST content of the readme file. This is likely caused by minor RST warnings, but pypi gives up and shows it raw. Change-Id: Ia2d6202ade5282d9aeae9bb948175aae2aa264cd
-rw-r--r--README.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 4cae735..488dd24 100644
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,6 @@
-===============================
+================
os-client-config
-===============================
+================
`os-client-config` is a library for collecting client configuration for
using an OpenStack cloud in a consistent and comprehensive manner. It
@@ -27,7 +27,9 @@ it by setting `OS_CLOUD_NAME`.
Service specific settings, like the nova service type, are set with the
default service type as a prefix. For instance, to set a special service_type
-for trove set::
+for trove set
+
+::
export OS_DATABASE_SERVICE_TYPE=rax:database
@@ -228,6 +230,7 @@ Usage
-----
The simplest and least useful thing you can do is:
+
::
python -m os_client_config.config
@@ -236,6 +239,7 @@ Which will print out whatever if finds for your config. If you want to use
it from python, which is much more likely what you want to do, things like:
Get a named cloud.
+
::
import os_client_config
@@ -245,7 +249,9 @@ Get a named cloud.
print(cloud_config.name, cloud_config.region, cloud_config.config)
Or, get all of the clouds.
+
::
+
import os_client_config
cloud_config = os_client_config.OpenStackConfig().get_all_clouds()