openstack/openstacksdk
Code Issues Proposed changes

Fleshed out the README and removed dependency on babel

Browse Source 
Change-Id: I65927ef6985ebdb46db08b9ac311a8d4df2706c6
This commit is contained in:
Alex Gaynor 2014-05-28 13:35:42 -07:00
parent 804d7af2e6
commit 48492fd37b
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -1,32 +1,37 @@
OpenStack Python SDK
====================
``python-openstacksdk`` is a ground-up implementation of a Python
API and SDK for OpenStack REST services.
``python-openstacksdk`` is a from scratch Python library and SDK for OpenStack
clouds. It is very young, and not yet usable, but it's under active
development.
Our goal is to provide a Python library which is:
* Pleasant to use
* Well documented
* Complete (works with any OpenStack project)
Building Documentation
----------------------
This documentation is written by contributors, for contributors.
The source is maintained in the ``doc/source`` folder using
The source is maintained in the ``doc/source/`` folder using
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/
* Building Manually::
To build the docs locally::
$ python setup.py build_sphinx
Results are in the `build/sphinx/html` directory.
Results are in the ``doc/build/sphinx/html/`` directory.
Requirements
------------
* Python 2.6+, Python 3.3+
* httpretty
* pbr
* requests

1
requirements.txt
View File

@ -1,4 +1,3 @@
pbr>=0.6,!=0.7,<1.0
Babel>=1.3
iso8601>=0.1.9
requests>=1.1