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.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
OpenDev Sysadmins 6680933d57 OpenDev Migration Patch 3 years ago
doc Update the tox.ini template and regenerate tox.ini 3 years ago
examples/demo Use a cyrilic unicode sample in the demo instead of japanese so that the pdf build is easier. 9 years ago
tests Python 3 compatibility: fix xrange/range issues 3 years ago
wsme Move CI jobs in-tree, add Python 3.6 and 3.7 3 years ago
wsmeext Improve handling of :module: in wsme documenters 3 years ago
.gitignore Set up dependencies for cross-tests 6 years ago
.gitreview OpenDev Migration Patch 3 years ago
.hgtags Added tag 0.5b2 for changeset d3e5eee0b150 9 years ago
.zuul.yaml Move CI jobs in-tree, add Python 3.6 and 3.7 3 years ago
LICENSE Add full MIT license 7 years ago
README.rst Change the repositories from stackforge to openstack 6 years ago
requirements-py3.txt Move ipaddr to netaddr 6 years ago
requirements.txt Move ipaddr to netaddr 6 years ago
setup.cfg Move CI jobs in-tree, add Python 3.6 and 3.7 3 years ago
setup.py Clean up setup.py and add requirements.txt 7 years ago
tox-tmpl.ini Update the tox.ini template and regenerate tox.ini 3 years ago
tox.ini Update the tox.ini template and regenerate tox.ini 3 years ago
toxgen.py Now use toxgen to produce the tox.ini file 9 years ago

README.rst

Web Services Made Easy

Introduction

Web Services Made Easy (WSME) simplifies the writing of REST web services by providing simple yet powerful typing, removing the need to directly manipulate the request and the response objects.

WSME can work standalone or on top of your favorite Python web (micro)framework, so you can use both your preferred way of routing your REST requests and most of the features of WSME that rely on the typing system like:

  • Alternate protocols, including those supporting batch-calls
  • Easy documentation through a Sphinx extension

WSME is originally a rewrite of TGWebServices with a focus on extensibility, framework-independance and better type handling.

How Easy ?

Here is a standalone wsgi example:

from wsme import WSRoot, expose

class MyService(WSRoot):
    @expose(unicode, unicode)  # First parameter is the return type,
                               # then the function argument types
    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:

URL Returns
http://<server>/ws/hello.json?who=you "Hello you !"
http://<server>/ws/hello.xml <result>Hello World !</result>
http://<server>/ws/api.wsdl A WSDL description for any SOAP client.

Main features

  • Very simple API.
  • Supports user-defined simple and complex types.
  • Multi-protocol : REST+Json, REST+XML, SOAP, ExtDirect and more to come.
  • Extensible : easy to add more protocols or more base types.
  • Framework independence : adapters are provided to easily integrate your API in any web framework, for example a wsgi container, Pecan, TurboGears, Flask, cornice...
  • Very few runtime dependencies: webob, simplegeneric. Optionnaly lxml and simplejson if you need better performances.
  • Integration in Sphinx for making clean documentation with wsmeext.sphinxext.

Install

pip install WSME

or, if you do not have pip on your system or virtualenv

easy_install WSME

Changes

Getting Help

Contribute