openstack
/
os-client-config
Code Issues Proposed changes

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
This commit is contained in:
Steve Martinelli 2015-09-22 17:19:13 -04:00
parent 512d00e208
commit 988e305b37
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -1,6 +1,6 @@
=============================== ================
os-client-config os-client-config
=============================== ================
`os-client-config` is a library for collecting client configuration for `os-client-config` is a library for collecting client configuration for
using an OpenStack cloud in a consistent and comprehensive manner. It 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 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 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 export OS_DATABASE_SERVICE_TYPE=rax:database
@ -228,6 +230,7 @@ Usage
----- -----
The simplest and least useful thing you can do is: The simplest and least useful thing you can do is:
:: ::
python -m os_client_config.config 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: it from python, which is much more likely what you want to do, things like:
Get a named cloud. Get a named cloud.
:: ::
import os_client_config import os_client_config
@ -245,7 +249,9 @@ Get a named cloud.
print(cloud_config.name, cloud_config.region, cloud_config.config) print(cloud_config.name, cloud_config.region, cloud_config.config)
Or, get all of the clouds. Or, get all of the clouds.
:: ::
import os_client_config import os_client_config
cloud_config = os_client_config.OpenStackConfig().get_all_clouds() cloud_config = os_client_config.OpenStackConfig().get_all_clouds()