allin

Allin is an experimental asynchronous web framework.

I didn't expect this framework to be used in a production environment, as it's still in the early stages of development. Not sure when this framework can be used in production 😬

You can help this project get better by creating an issue or PR. Thank you for your time!

Table of Contents:

• 🤨 Why ?

• 📚 Roadmap

• 🤩 Features

• 🤟 Quick Start

• 😎 Installation

  • From source
  • With pip

Allin is heavily inspired by Flask, Starlette & Falcon.

🤨 Why ?

I'm just curious 🧐

Yup, I'm curious about how a web application based on ASGI works.

It may not yet fully comply with the ASGI application specifications as documented. But, for the main features like route mapping, HTTP responses, error handling, parsing the request body it's there.

...and I want to build my own framework from scratch so I know how the application works.

Literally, the "framework parts" weren't built from scratch as I also used third party modules and some "parts from other sources" were used as references.

This is part of the journey

📚 Roadmap

• Lifespan Protocol

• HTTP Protocol

  • HTTP Headers

  • HTTP Request

    • JSON Body Support
    • MessagePack Body Support
    • Form Data Support
    • Cookies
    • Query Parameters

  • HTTP Responses

    • JSONResponse
    • MessagePackResponse

  • HTTP Middleware

    • Before HTTP Request
    • After HTTP Request

  • Routing

    • Decorator shortcuts such as @get, @post, @put, etc. are available.
    • Nesting routers

• Extension

• Websocket Support

🤩 Features

• Global variables. (It means, you can access the app and request object instances globally)
• Error handling
• JSON and MessagePack requests are supported out of the box (thanks to msgspec)
• Form Data Support (application/x-www-form-urlencoded or multipart/form-data)
• Decorator shortcuts such as @get, @post, @put, etc. are available.
• Nesting routers

🤟 Quick Start

Here is an example application based on the Allin framework and I'm sure you are familiar with it.

from allin import Allin, JSONResponse

app = Allin()

@app.route("/")
async def index():
    return JSONResponse({"message": "Hello World!"})

👇 Explanation

• The app variable is the ASGI application instance.
• And we create an endpoint with the route / on the line app.route(...)
• Then we add the index() function to handle the / route.
• And the handler function will return a JSON response with the content {"message": "Hello World!"}

That's it! looks familiar right?

Want more? check out other sample projects here

😎 Installation

Install from source

git clone --depth 1 https://github.com/aprilahijriyan/allin.git
cd allin

Need https://python-poetry.org/ installed on your device

poetry build
pip install ./dist/*.whl

Install with pip

Currently I just published the pre-release version v0.1.1a0. So, maybe you need to install it with the --pre option. Example:

pip install --pre allin