From 9ddfc01efb7afa54682cb8c0b89a43b9490bc054 Mon Sep 17 00:00:00 2001 From: Christophe de Vienne Date: Sat, 22 Oct 2011 15:59:24 +0200 Subject: [PATCH] Now read the long_description and the doc introduction from the README file. --- README | 40 ++++++++++++++++++++++++++++++---------- doc/index.rst | 37 +------------------------------------ setup.py | 2 ++ wsme/release.py | 3 --- 4 files changed, 33 insertions(+), 49 deletions(-) diff --git a/README b/README index 8577e5e..69de1f7 100644 --- a/README +++ b/README @@ -1,16 +1,36 @@ -WSME -==== - Web Service Made Easy (WSME) is a very easy way to implement webservices in your python web application. It is originally a rewrite of TGWebServices -with focus on extensibility and framework-independance. +with focus on extensibility, framework-independance and better type handling. -Main features are: +Main features +~~~~~~~~~~~~~ -- Very simple API +- Very simple API. - Supports user defined complex types. -- Multi-protocol : REST+Json, REST+XML, SOAP, and more to come +- Multi-protocol : REST+Json, REST+XML, SOAP, and more to come. - Extensible : easy to add more protocols or more base types. -- WSGI application : can be used within any web framework -- Depends on webob, simplegeneric (+ Genshi if you use SOAP) -- Integration in Sphinx for making clean documentation +- Framework independance : adapters are provided to easily integrate + your API in any web framework, for example a wsgi container, + turbogears, and more to come. +- Very few runtime dependencies: webob, simplegeneric + (+ Genshi if you use SOAP). +- Integration in Sphinx for making clean documentation with + sphinxcontrib-wsme (not released yet). + +Install +~~~~~~~ + +.. code-block:: bash + + easy_install WSME + +Getting Help +~~~~~~~~~~~~ + +Questions about WSME should to the `python-wsme mailinglist`_. + +Contribute +~~~~~~~~~~ + +:Report issues: `WSME issue tracker`_ +:Source code: hg clone https://bitbucket.org/cdevienne/wsme/ diff --git a/doc/index.rst b/doc/index.rst index 0de7249..604b583 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,42 +4,7 @@ Web Services Made Easy Introduction ------------ -Web Service Made Easy (WSME) is a very easy way to implement webservices -in your python web application. It is originally a rewrite of TGWebServices -with focus on extensibility, framework-independance and better type handling. - -Main features -~~~~~~~~~~~~~ - -- Very simple API. -- Supports user defined complex types. -- Multi-protocol : REST+Json, REST+XML, SOAP, and more to come. -- Extensible : easy to add more protocols or more base types. -- Framework independance : adapters are provided to easily integrate - your API in any web framework, for example a wsgi container, - turbogears, and more to come. -- Very few runtime dependencies: webob, simplegeneric - (+ Genshi if you use SOAP). -- Integration in Sphinx for making clean documentation with - sphinxcontrib-wsme (not released yet). - -Install -~~~~~~~ - -.. code-block:: bash - - easy_install WSME - -Getting Help -~~~~~~~~~~~~ - -Questions about WSME should to the `python-wsme mailinglist`_. - -Contribute -~~~~~~~~~~ - -:Report issues: `WSME issue tracker`_ -:Source code: hg clone https://bitbucket.org/cdevienne/wsme/ +.. include:: ../README Contents -------- diff --git a/setup.py b/setup.py index 81ce88c..caea55d 100644 --- a/setup.py +++ b/setup.py @@ -4,6 +4,8 @@ from setuptools import setup execfile(os.path.join('wsme', 'release.py')) +long_description = open("README").read() + setup( name=name, version=version, diff --git a/wsme/release.py b/wsme/release.py index b42c571..073ca8b 100644 --- a/wsme/release.py +++ b/wsme/release.py @@ -2,9 +2,6 @@ name = "WSME" version = "0.1.1" description = "Web Services Made Easy" -long_description = """ -Web Service Made Easy is a pure-wsgi and modular rewrite of TGWebServices. -""" author = "Christophe de Vienne" email = "python-wsme@googlegroups.com"