Merge "Fleshed out the README and removed dependency on babel"

This commit is contained in:
Jenkins 2014-06-04 14:36:29 +00:00 committed by Gerrit Code Review
commit 4fe2b1d884
2 changed files with 11 additions and 7 deletions

@ -1,32 +1,37 @@
OpenStack Python SDK OpenStack Python SDK
==================== ====================
``python-openstacksdk`` is a ground-up implementation of a Python ``python-openstacksdk`` is a from scratch Python library and SDK for OpenStack
API and SDK for OpenStack REST services. 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 Building Documentation
---------------------- ----------------------
This documentation is written by contributors, for contributors. 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`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/ .. _Sphinx: http://sphinx.pocoo.org/
* Building Manually:: To build the docs locally::
$ python setup.py build_sphinx $ python setup.py build_sphinx
Results are in the `build/sphinx/html` directory. Results are in the ``doc/build/sphinx/html/`` directory.
Requirements Requirements
------------ ------------
* Python 2.6+, Python 3.3+ * Python 2.6+, Python 3.3+
* httpretty
* pbr * pbr
* requests * requests

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