PyExpress

PyExpress is a minimal web application framework for Python 3 inpired by ExpressJS. The project started as a part of a task for a job application then continued as a way of exploring how web frameworks work on the inside. The code is based on this tutorial.

Install:

Right now, the only way to use the framework is by cloning the source code. When it reaches a usable state, it will be Uploaded to PyPI

pip install git+https://github.com/iahvector/PyExpress.git@0.1.0-alpha#egg=PyExpress

or you can use the -e option to install the package in editable mode

pip install -e git+https://github.com/iahvector/PyExpress.git@0.1.0-alpha#egg=PyExpress

Documentation:

The Router is WSGI application. It accespts other WSGI applications as route handlers

from PyExpress import Router, CONTENT_TYPE_JSON
from webob import Response, exc

# A function to handle a route. Routes are WSGI apps. the Router.app decorator wraps
# the function in a WSGI app
# req is a WebOb request object
# id and name are path variables parsed by the router
@Router.app
def handler(req, id, name):
    # Extras passed to the route are accessed using the dict req.extras
    available = req.extras['available']

    if id in available:
        res_json = {
            'id': id,
            'name': name
        }
        res_body = json.dumps(res_json)
        return Response(body=res_body, content_type=CONTENT_TYPE_JSON,
                        charset='UTF-8')
    else:
        return exc.HTTPNotFound()


# Initialize the router
app = Router()

# Add routes to the router
# - {id:\d+} is a path variable named id and matches the regex \d+ which matches
# any number
# {name} is path variable named name and matches any thing
# - A route has an HTTP method, one of Router.METHOD_GET, Router.METHOD_POST,
# Router.METHOD_PUT and Router.METHOD_DELETE
# - available is an extra variable. all variables passed after the route handler
# can be accessed as an extras dict from the request object
app.use('/api/v1/resource/{id:\d+}/{name}',
        Router.METHOD_GET,
        handler,
        available=[1, 2 ,3, 4, 5])

Run like any WSGI application. For example, to run using Gunicorn, assuming the previous script is saved in example.py use

gunicorn example:app