Afterburner: Python Web Framework build for learning purposes

Afterburner is a Python web framework built for learning purposes.

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

Installation

pip install afterburner

How to use it

Basic usage:

from afterburner.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": "Afterburner", "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 Afterburner. 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 afterburner.middleware.Middleware class and overriding its two methods that are called before and after each request:

from afterburner.api import API
from afterburner.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)

Release files for afterburner 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for afterburner 0.0.2
File	Size	Uploaded
afterburner-0.0.2.tar.gz	5.1 kB	Dec 27, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for afterburner 0.0.2
File	Interpreter	ABI	Platform	Reset
afterburner-0.0.2-py3-none-any.whl 5.4 kB Dec 27, 2019	Python 3	none	any	Details

Total release size: 10.5 kB

Release files / afterburner-0.0.2.tar.gz

Download URL	afterburner-0.0.2.tar.gz
Size	5.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`fb28b414700a9b05cb25469b9a2af7d89d31b21963775611a43349117e1c93a3`
BLAKE2b-256 checksum How to use checksums	`ec33bb98f15207287a0474f677405a343094849e3493dfe0da828e0a124ee04f`
Upload date	Dec 27, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6`

Release files / afterburner-0.0.2-py3-none-any.whl

Download URL	afterburner-0.0.2-py3-none-any.whl
Size	5.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6ce4316f794fd3b7aa4bf73e3411353a2b6989e416eeffbac3f72be3e6ed7e9f`
BLAKE2b-256 checksum How to use checksums	`a2547c1996918fb427f0fdc08b0d23b6398ad86d720ae7adc4bbbfffe68dd2f2`
Upload date	Dec 27, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6`