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.
 
 
Thomas Goirand a3ce4a1542 Python 3.9: use encodebytes / decodebytes 3 months ago
doc Rework documentation build 1 year ago
examples/demo Remove support for SPORE protcol 1 year ago
tests Rework documentation build 1 year ago
wsme Python 3.9: use encodebytes / decodebytes 3 months ago
wsmeext sphinxext: Fix Sphinx 3.0 compatibility 1 year ago
.gitignore gitignore: Ignore '.eggs' directory 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.hgtags Added tag 0.5b2 for changeset d3e5eee0b150 7 years ago
.zuul.yaml Move CI jobs in-tree, add Python 3.6 and 3.7 1 year ago
LICENSE Add full MIT license 5 years ago
README.rst Fix misc README issues 1 year ago
requirements.txt WebOb: Do not use the deprecated best_match method 1 year ago
setup.cfg Merge "Remove support for SOAP protocol" 1 year ago
setup.py Clean up setup.py and add requirements.txt 5 years ago
test-requirements.txt tox: Remove pecan-devNN tox targets, centralize deps 1 year ago
tox.ini tox: Remove pecan-devNN tox targets, centralize deps 1 year 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-independence 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'])
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>

Main features

  • Very simple API.
  • Supports user-defined simple and complex types.
  • Multi-protocol : REST+JSON, REST+XML and more possible.
  • 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 an WSGI container, Pecan, Flask, ...
  • Very few runtime dependencies: webob, simplegeneric.
  • Integration in Sphinx for making clean documentation with wsmeext.sphinxext.

Install

pip install WSME

Changes

Getting Help

Contribute