openstack
/
deb-python-wsme
Code Issues Proposed changes
RETIRED, further work has moved to Debian project infrastructure
724 Commits 2 Branches 36 Tags 853 KiB
Go to file
houming-wang 30bb63a6f5 Fix jenkins failure 
Fix the failed test case

Traceback (most recent call last):
  File "/opt/stack/wsme/wsme/tests/test_utils.py", line 78, in
test_parse_isodatetime
    self.assertRaises(ValueError, utils.parse_isodatetime, s)
AssertionError: ValueError not raised

Change-Id: I6c36f8b0340cd7b4c6f35e7c7c5886598e2c5f0c
Closes-Bug: #1532734
 		2016-03-08 09:40:15 +00:00
doc Change the repositories from stackforge to openstack 2015-10-19 14:51:33 +05:30
examples/demo Use a cyrilic unicode sample in the demo instead of japanese so that the pdf build is easier. 2013-04-09 11:56:40 +02:00
tests Replace deprecated assertEquals with assertEqual 2015-05-13 18:35:41 +02:00
wsme Fix jenkins failure 2016-03-08 09:40:15 +00:00
wsmeext Replace deprecated assertEquals with assertEqual 2015-05-13 18:35:41 +02:00
.gitignore Set up dependencies for cross-tests 2015-06-01 13:53:09 +00:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:41:53 +00:00
.hgtags Added tag 0.5b2 for changeset d3e5eee0b150 2013-04-18 19:55:18 +02:00
LICENSE Add full MIT license 2015-04-21 16:10:25 +01:00
README.rst Change the repositories from stackforge to openstack 2015-10-19 14:51:33 +05:30
requirements-py3.txt Move ipaddr to netaddr 2015-05-27 23:20:40 +08:00
requirements.txt Move ipaddr to netaddr 2015-05-27 23:20:40 +08:00
setup.cfg Change the repositories from stackforge to openstack 2015-10-19 14:51:33 +05:30
setup.py Clean up setup.py and add requirements.txt 2015-04-21 23:42:59 +01:00
tox-tmpl.ini Set up dependencies for cross-tests 2015-06-01 13:53:09 +00:00
tox.ini Set up dependencies for cross-tests 2015-06-01 13:53:09 +00:00
toxgen.py Now use toxgen to produce the tox.ini file 2013-01-25 17:40:32 +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-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