openstack/python-novaclient
Code Issues Proposed changes

Updated README.rst

Browse Source 
- Changed link from Rackspace API docs to OpenStack API docs
- Fixed Github link
- Added Launchpad link
- Added Gerrit link

Change-Id: I0494e4c4a8722c182c63515cb6079d2c1557b52f
This commit is contained in:
Lorin Hochstein 2011-12-01 22:13:07 -05:00
parent b61a8d8c24
commit 9067f26077
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -9,16 +9,20 @@ implements 100% of the OpenStack Nova API.
__ http://packages.python.org/python-novaclient/ __ http://packages.python.org/python-novaclient/
You'll also probably want to read `Rackspace's API guide`__ (PDF) -- the first You'll also probably want to read `OpenStack Compute Developer Guide API`__ --
bit, at least -- to get an idea of the concepts. Rackspace is doing the cloud the first bit, at least -- to get an idea of the concepts. Rackspace is doing
hosting thing a bit differently from Amazon, and if you get the concepts this the cloud hosting thing a bit differently from Amazon, and if you get the
library should make more sense. concepts this library should make more sense.
__ http://docs.rackspacecloud.com/servers/api/cs-devguide-latest.pdf __ http://docs.openstack.org/api/
Development takes place on GitHub__. Bug reports and patches may be filed there. The project is hosted on `Launchpad`_, where bugs can be filed. The code is
hosted on `Github`_. Patches must be submitted using `Gerrit`_, *not* Github
pull requests.
__ https://github.com/rackspace/python-client .. _Github: https://github.com/openstack/python-novaclient
.. _Launchpad: https://launchpad.net/python-novaclient
.. _Gerrit: http://wiki.openstack.org/GerritWorkflow
This code a fork of `Jacobian's python-cloudservers`__ If you need API support This code a fork of `Jacobian's python-cloudservers`__ If you need API support
for the Rackspace API soley or the BSD license, you should use that repository. for the Rackspace API soley or the BSD license, you should use that repository.
@ -36,8 +40,8 @@ Installing this package gets you a shell command, ``nova``, that you
can use to interact with any Rackspace compatible API (including OpenStack). can use to interact with any Rackspace compatible API (including OpenStack).
You'll need to provide your OpenStack username and API key. You can do this You'll need to provide your OpenStack username and API key. You can do this
with the ``--username``, ``--password`` and ``--projectid`` params, but it's easier to just with the ``--username``, ``--password`` and ``--projectid`` params, but it's
set them as environment variables:: easier to just set them as environment variables::
export NOVA_USERNAME=openstack export NOVA_USERNAME=openstack
export NOVA_PASSWORD=yadayada export NOVA_PASSWORD=yadayada