summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-06-09 21:36:11 +0000
committerGerrit Code Review <review@openstack.org>2015-06-09 21:36:11 +0000
commit0c724c9975463376f984fd972eeea524cb1def29 (patch)
tree1b83b5affdfd6ca5ffe956b6727df5ac982043cc /README.rst
parent945183d2b51bb252802f940ecbe53e0bfd0e1c03 (diff)
parentefe988d29ab13e645277e69d26779777f952de15 (diff)
downloadpython-novaclient-0c724c9975463376f984fd972eeea524cb1def29.tar.gz
Merge "Cleanup various inaccuracies in the README.rst"
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 0faa248e..00a361de 100644
--- a/README.rst
+++ b/README.rst
@@ -45,7 +45,7 @@ You will also need to define the authentication url with ``--os-auth-url``
and the version of the API with ``--os-compute-api-version``. Or set them as
an environment variables as well::
- export OS_AUTH_URL=http://example.com:8774/v1.1/
+ export OS_AUTH_URL=http://example.com:8774/v2/
export OS_COMPUTE_API_VERSION=2
If you are using Keystone, you need to set the OS_AUTH_URL to the keystone
@@ -63,14 +63,13 @@ You'll find complete documentation on the shell by running
Python API
----------
-There's also a complete Python API, but it has not yet been documented.
+There's also a complete Python API, with documentation linked below.
-To use with nova, with keystone as the authentication system::
+To use with keystone as the authentication system::
- # use v2.0 auth with http://example.com:5000/v2.0/")
- >>> from novaclient.v2 import client
- >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute")
+ >>> from novaclient import client
+ >>> nt = client.Client(VERSION, USER, PASSWORD, TENANT, AUTH_URL)
>>> nt.flavors.list()
[...]
>>> nt.servers.list()
@@ -94,7 +93,7 @@ There are multiple test targets that can be run to validate the code.
* tox -e functional - live functional testing against an existing
openstack
-Functional testing assumes the existance of a `clouds.yaml` file as supported
+Functional testing assumes the existence of a `clouds.yaml` file as supported
by `os-client-config` (http://docs.openstack.org/developer/os-client-config)
It assumes the existence of a cloud named `devstack` that behaves like a normal
devstack installation with a demo and an admin user/tenant - or clouds named