From 5f5dd7fe5e0d20060e1c1c6a1cc85d74a705f1c3 Mon Sep 17 00:00:00 2001 From: Christophe de Vienne Date: Wed, 30 Jan 2013 00:30:04 +0100 Subject: [PATCH] Rewrite a bit the introduction text --- README.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index d67d114..1734992 100644 --- a/README.rst +++ b/README.rst @@ -4,17 +4,24 @@ Web Services Made Easy Introduction ------------ -Web Service Made Easy (WSME) is a very easy way to implement webservices -in your python web application, and to add strong type checking to your favorite -REST library/framework, as well as additional protocols. +Web Service Made Easy (WSME) simplify the writing of REST web services +by providing simple yet powerful typing which removes the need to directly +manipulate the request and the response objects. -It is originally a rewrite of TGWebServices +WSME can work standalone or on top of your favorite python web +(micro)framework, so you can use both your prefered way of routing your REST +requests and most of the features of WSME that rely on the typing system like: + +- Alternate protocols, including ones supporting batch-calls +- Easy documentation through a Sphinx_ extension + +WSME is originally a rewrite of TGWebServices with focus on extensibility, framework-independance and better type handling. How Easy ? ~~~~~~~~~~ -:: +Here is a standalone wsgi example:: from wsme import WSRoot, expose, validate @@ -24,6 +31,8 @@ How Easy ? def hello(self, who=u'World'): return u"Hello {0} !".format(who) + ws = MyService(protocols=['restjson', 'restxml', 'soap']) + application = ws.wsgiapp() With this published at the ``/ws`` path of your application, you can access your hello function in various protocols: