A Python framework for building HTTP-based server applications
Project description
Rolo HTTP: A Python framework for building HTTP-based server applications.
Rolo HTTP
Rolo is a flexible framework and library to build HTTP-based server applications beyond microservices and REST APIs. You can build HTTP-based RPC servers, websocket proxies, or other server types that typical web frameworks are not designed for.
Rolo extends Werkzeug, a flexible Python HTTP server library, for you to use concepts you are familiar with like Router
, Request
, Response
, or @route
.
It introduces the concept of a Gateway
and HandlerChain
, an implementation variant of the chain-of-responsibility pattern.
Rolo is designed for environments that do not use asyncio, but still require asynchronous HTTP features like HTTP2 SSE or Websockets. To allow asynchronous communication, Rolo introduces an ASGI/WSGI bridge, that allows you to serve Rolo applications through ASGI servers like Hypercorn.
Usage
Default router example
from rolo import Router, route, Response
from werkzeug import Request
from werkzeug.serving import run_simple
@route("/users")
def user(_: Request, args):
assert not args
return Response("user")
@route("/users/<int:user_id>")
def user_id(_: Request, args):
assert args
return Response(f"{args['user_id']}")
router = Router()
router.add(user)
router.add(user_id)
# convert Router to a WSGI app and serve it through werkzeug
run_simple('localhost', 8080, router.wsgi(), use_reloader=True)
Gateway & Handler Chain
A rolo Gateway
holds a set of request, response, and exception handlers, as well as request finalizers.
Gateway instances can then be served as WSGI or ASGI applications by using the appropriate serving adapter.
Here is a simple example of a Gateway with just one handler that returns the URL and method that was invoked.
from werkzeug import run_simple
from rolo import Response
from rolo.gateway import Gateway, HandlerChain, RequestContext
from rolo.gateway.wsgi import WsgiGateway
def echo_handler(chain: HandlerChain, context: RequestContext, response: Response):
response.status_code = 200
response.set_json({"url": context.request.url, "method": context.request.method})
gateway = Gateway(request_handlers=[echo_handler])
app = WsgiGateway(gateway)
run_simple("localhost", 8080, app, use_reloader=True)
Serving this will yield:
curl http://localhost:8080/hello-world
{"url": "http://localhost:8080/hello-world", "method": "GET"}
Develop
Quickstart
to install the python and other developer requirements into a venv run:
make install
Format code
We use black and isort as code style tools. To execute them, run:
make format
Build distribution
To build a wheel and source distribution, simply run
make dist
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.