From 48492fd37beea8f76c32c57d0624d7bea171039e Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 28 May 2014 13:35:42 -0700 Subject: [PATCH] Fleshed out the README and removed dependency on babel Change-Id: I65927ef6985ebdb46db08b9ac311a8d4df2706c6 --- README.rst | 17 +++++++++++------ requirements.txt | 1 - 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index d5d9ca896..509c00e68 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/requirements.txt b/requirements.txt index c42f93a69..026975181 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ pbr>=0.6,!=0.7,<1.0 -Babel>=1.3 iso8601>=0.1.9 requests>=1.1