Bumbo Python Web Framework built for learning purposes.

Project description

Bumbo: Python Web Framework built for learning purposes

purpose PyPI

Bumbo is a Python web framework built for learning purposes.

It's a WSGI framework and can be used with any WSGI application server such as Gunicorn.

Installation

pip install bumbo

How to use it

Basic usage:

from bumbo.api import API

app = API()


@app.route("/home")
def home(request, response):
    response.text = "Hello from the HOME page"


@app.route("/hello/{name}")
def greeting(request, response, name):
    response.text = f"Hello, {name}"


@app.route("/book")
class BooksResource:
    def get(self, req, resp):
        resp.text = "Books Page"

    def post(self, req, resp):
        resp.text = "Endpoint to create a book"


@app.route("/template")
def template_handler(req, resp):
    resp.body = app.template(
        "index.html", context={"name": "Bumbo", "title": "Best Framework"}).encode()

Unit Tests

The recommended way of writing unit tests is with pytest. There are two built in fixtures that you may want to use when writing unit tests with Bumbo. The first one is app which is an instance of the main API class:

def test_route_overlap_throws_exception(app):
    @app.route("/")
    def home(req, resp):
        resp.text = "Welcome Home."

    with pytest.raises(AssertionError):
        @app.route("/")
        def home2(req, resp):
            resp.text = "Welcome Home2."

The other one is client that you can use to send HTTP requests to your handlers. It is based on the famous requests and it should feel very familiar:

def test_parameterized_route(app, client):
    @app.route("/{name}")
    def hello(req, resp, name):
        resp.text = f"hey {name}"

    assert client.get("http://testserver/matthew").text == "hey matthew"

Templates

The default folder for templates is templates. You can change it when initializing the main API() class:

app = API(templates_dir="templates_dir_name")

Then you can use HTML files in that folder like so in a handler:

@app.route("/show/template")
def handler_with_template(req, resp):
    resp.html = app.template(
        "example.html", context={"title": "Awesome Framework", "body": "welcome to the future!"})

Static Files

Just like templates, the default folder for static files is static and you can override it:

app = API(static_dir="static_dir_name")

Then you can use the files inside this folder in HTML files:

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <title>{{title}}</title>

  <link href="/static/main.css" rel="stylesheet" type="text/css">
</head>

<body>
    <h1>{{body}}</h1>
    <p>This is a paragraph</p>
</body>
</html>

Middleware

You can create custom middleware classes by inheriting from the bumbo.middleware.Middleware class and overriding its two methods that are called before and after each request:

from bumbo.api import API
from bumbo.middleware import Middleware


app = API()


class SimpleCustomMiddleware(Middleware):
    def process_request(self, req):
        print("Before dispatch", req.url)

    def process_response(self, req, res):
        print("After dispatch", req.url)


app.add_middleware(SimpleCustomMiddleware)

Project details

Release history Release notifications | RSS feed

This version

0.0.2

Nov 24, 2019

0.0.1

Nov 23, 2019

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bumboraphael, version 0.0.2
Filename, size	File type	Python version	Upload date	Hashes
Filename, size bumboraphael-0.0.2.tar.gz (5.9 kB)	File type Source	Python version None	Upload date Nov 24, 2019	Hashes View
Filename, size bumboraphael-0.0.2-py3-none-any.whl (5.7 kB)	File type Wheel	Python version py3	Upload date Nov 24, 2019	Hashes View

Hashes for bumboraphael-0.0.2.tar.gz

Hashes for bumboraphael-0.0.2.tar.gz
Algorithm	Hash digest
SHA256	`ec9c4d832352e2cefa5d5c3acf691b2be697a0d31d76f1e75dd4a6fefe68ea17`
MD5	`86e88633383bc917a49653177d7e7696`
BLAKE2-256	`c178c5731cc5e00ef2f8f5ab721b28dd87c8590433d79933b2b1f9fcb314f31a`

Hashes for bumboraphael-0.0.2-py3-none-any.whl

Hashes for bumboraphael-0.0.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1ac68b6dc3b825db8dd8a5e3daaf9242b4f0de5d9108c53ec290e9da4fce14dc`
MD5	`f1378204d8d1e8011991fc15ea570c14`
BLAKE2-256	`d18a0dba13658ef89437a913062ce62c94fb92ce5ff788718797106bc7c175cc`