wsme/doc/integrate.rst

Integrating with a Framework

WSGI Application

The wsme.WSRoot.wsgiapp function of WSRoot returns a wsgi application.

Example

from wsme import WSRoot, expose


class MyRoot(WSRoot):
    @expose(unicode)
    def helloworld(self):
        return u"Hello World !"

root = MyRoot(protocols=['restjson'])
application = root.wsgiapp()

Bottle

import bottle
import wsme

class MyRoot(wsme.WSRoot):
    @wsme.expose(unicode)
    def helloworld(self):
        return u"Hello World !"

root = MyRoot(webpath='/ws', protocols=['restjson'])

bottle.mount('/ws', root.wsgiapp())
bottle.run()

Pyramid

The WSRoot._handle_request method is a valid pyramid view:

from paste.httpserver import serve
from pyramid.config import Configurator

from wsme import *

class WSController(WSRoot):
    @expose(int)
    @validate(int, int)
    def multiply(self, a, b):
        return a * b

myroot = WSRoot()
myroot.addprotocol('restjson')
myroot.addprotocol('extdirect')

if __name__ == '__main__':
    config = Configurator()
    config.add_route('ws', '')
    config.add_view(wsroot._handle_request, route_name='ws')
    app = config.make_wsgi_app()
    serve(app, host='0.0.0.0')

Turbogears 1.x

wsme.tg1 -- TG1 adapter

wsme.tg1

A TG1 Controller that publish a wsme.WSRoot.

adapt

Returns a Controller that publish a wsme.WSRoot.

wsme.tg15 -- TG 1.5 adapter

wsme.tg15

A TG1 Controller that publish a wsme.WSRoot.

adapt

Returns a Controller that publish a wsme.WSRoot.

Example

In a freshly quickstarted tg1 application (let's say, wsmedemo), the prefered way is the following :

Create a new file, "wsmedemo/ws.py" :

import wsme.tg1
from wsme import expose, validate, WSRoot

class WSController(WSRoot):
    @expose(int)
    @validate(int, int)
    def multiply(self, a, b):
        return a * b

Insert the ws controller in the controller tree, (file controllers.py):

# ...

from wsmedemo.ws import WSController

import wsme.tg1

class Root(controllers.RootController):
    ws = wsme.tg1.adapt(
        WSController(webpath='/ws', protocols=['restjson']))

    # ...