x/wsme
Code Issues Proposed changes
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.
783 Commits 1 Branch 34 Tags 2.3 MiB
Python 100%
0f3ed67f20
Go to file
Stephen Finucane 0f3ed67f20 Drop Python 2.7 support 
This is now a Python 3-only package.

Change-Id: I1923d1dcd92cce349211dee5b01a3c365b151ead
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-07-26 17:19:34 +01:00
doc Rework documentation build 2019-11-18 13:58:59 -08:00
examples/demo Remove support for SPORE protcol 2019-05-02 10:56:51 -06:00
tests Rework documentation build 2019-11-18 13:58:59 -08:00
wsme Fix coverage and getargspec deprecation 2020-11-19 10:07:27 -08:00
wsmeext Fix coverage and getargspec deprecation 2020-11-19 10:07:27 -08:00
.gitignore gitignore: Ignore '.eggs' directory 2019-05-02 09:40:40 -06:00
.gitreview OpenDev Migration Patch 2019-04-19 19:50:34 +00:00
.hgtags Added tag 0.5b2 for changeset d3e5eee0b150 2013-04-18 19:55:18 +02:00
.zuul.yaml Drop Python 2.7 support 2021-07-26 17:19:34 +01:00
LICENSE Add full MIT license 2015-04-21 16:10:25 +01:00
README.rst Fix misc README issues 2019-12-19 12:18:31 +00:00
requirements.txt WebOb: Do not use the deprecated best_match method 2019-05-02 19:44:02 +00:00
setup.cfg Drop Python 2.7 support 2021-07-26 17:19:34 +01:00
setup.py Clean up setup.py and add requirements.txt 2015-04-21 23:42:59 +01:00
test-requirements.txt Fix coverage and getargspec deprecation 2020-11-19 10:07:27 -08:00
tox.ini Drop Python 2.7 support 2021-07-26 17:19:34 +01:00

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