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.
772 Commits 1 Branch 34 Tags 2.3 MiB
Python 100%
Go to file
Stephen Finucane 993d8a06d5 Undo rename of 'wsme.rest.json', 'wsme.rest.xml' modules 
Use absolute imports to ensure we import the standard library 'json'
module and not our module that shadows it.

Change-Id: I7b55aad974a0145934069f14c91ce03e41bccef3
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
 		2019-05-15 12:24:22 +01:00
doc Remove support for SPORE protcol 2019-05-02 10:56:51 -06:00
examples/demo Remove support for SPORE protcol 2019-05-02 10:56:51 -06:00
tests Remove cornice integration 2019-05-02 09:41:00 -06:00
wsme Undo rename of 'wsme.rest.json', 'wsme.rest.xml' modules 2019-05-15 12:24:22 +01:00
wsmeext Undo rename of 'wsme.rest.json', 'wsme.rest.xml' modules 2019-05-15 12:24:22 +01: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 Move CI jobs in-tree, add Python 3.6 and 3.7 2019-03-12 12:20:36 +01:00
LICENSE Add full MIT license 2015-04-21 16:10:25 +01:00
README.rst Remove simplejson support 2019-05-02 10:58:12 -06:00
requirements-py3.txt WebOb: Do not use the deprecated best_match method 2019-05-02 19:44:02 +00:00
requirements.txt WebOb: Do not use the deprecated best_match method 2019-05-02 19:44:02 +00:00
setup.cfg Merge "Remove support for SOAP protocol" 2019-05-14 16:41:28 +00:00
setup.py Clean up setup.py and add requirements.txt 2015-04-21 23:42:59 +01:00
tox.ini Remove simplejson support 2019-05-02 10:58:12 -06: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-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'])
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 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, Flask, ...
  • Very few runtime dependencies: webob, simplegeneric.
  • 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