shellbot.routes package

Module contents

class shellbot.routes.Route(context=None, **kwargs)[source]

Bases: object

Implements one route

delete()[source]
get(**kwargs)[source]
post()[source]
put()[source]
route = None
class shellbot.routes.Notifier(context=None, **kwargs)[source]

Bases: shellbot.routes.base.Route

Notifies a queue on web request

>>>queue = Queue() >>>route = Notifier(route=’/notify’, queue=queue, notification=’hello’)

When the route is requested over the web, the notification is pushed to the queue.

>>>queue.get() ‘hello’

Notification is triggered on GET, POST, PUT and DELETE verbs.

delete()[source]
get(**kwargs)[source]
notification = None
notify()[source]
post()[source]
put()[source]
queue = <shellbot.routes.notifier.NoQueue object>
route = '/notify'
class shellbot.routes.Text(context=None, **kwargs)[source]

Bases: shellbot.routes.base.Route

Implements a static web page

>>>page = “<html> ... </html>” >>>route = text(route=’/index’, page=page)

When the route is requested over the web, static content is provided in return.

>>>route.get() “<html> ... </html>”

This class handles only GET requests.

get()[source]
page = None
route = '/'
class shellbot.routes.Wrapper(context=None, **kwargs)[source]

Bases: shellbot.routes.base.Route

Calls a function on web request

When the route is requested over the web, the wrapped function is called.

Example:

def my_callable(**kwargs):
    ...

route = Wrapper(callable=my_callable, route='/hook')

Wrapping is triggered on GET, POST, PUT and DELETE verbs.

callable = None
delete()[source]
get(**kwargs)[source]
post()[source]
put()[source]
route = None