muffin 0.79.0

Muffin is a fast, simple and asyncronous web-framework for Python 3 (asyncio, trio)

Muffin – is a fast, lightweight and asyncronous ASGI web-framework for Python 3.

---

Features

• ASGI compatible;

• Competitive Performance;

• All async python libraries are supported (Asyncio, Trio, Curio);

• Send HTTP (text, html, json, stream, file, http errors) responses

• Support WebSockets, Server Side Events

Docs are available at https://klen.github.io/muffin/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome.

Contents

• Features

• Installation

  • Dependencies

• Quickstart

• Plugins overview

  • Muffin-Jinja2

  • Muffin-Session

  • Muffin-OAuth

  • Muffin-Sentry

  • Muffin-Peewee

  • Muffin-Babel

  • Muffin-Databases

  • Muffin-Mongo

  • Muffin-REST

  • Muffin-Redis

  • Muffin-Admin

  • Muffin-Prometheus

• Benchmarks

• Bug tracker

• Contributing

• Contributors

• License

Installation

We recommend using the latest version of Python. The library supports Python 3.7 and newer (PyPy-3.7 are supported too).

Muffin should be installed using pip:

pip install muffin

The command will install minimal configuration.

To install Muffin with gunicorn, uvicorn, uvloop, httptools use the command:

$ pip install muffin[standard]

Dependencies

These distributions will be installed automatically when installing Muffin.

• ASGI-Tools - ASGI Toolkit

• Modconfig - Simple hierarchic configuration manager

Quickstart

Example “Hello User” with the Muffin:

import muffin


app = muffin.Application()


@app.route('/', '/hello/{name}')
async def hello(request):
    name = request.path_params.get('name', 'world')
    return f'Hello {name.title()}!'

What did that code do?

1. First we imported the muffin.Application class. An instance of this class will be our application.

2. Next we create an instance of this class. The first argument is the name of the application.

3. We then use the muffin.Application.route decorator to tell Muffin what URLs should trigger our handler function.

4. The function returns the message we want to display in the user’s browser.

Save the script as example.py and run it using Uvicorn (or another ASGI server):

$ uvicorn example:app

Open http://localhost:8000, http://localhost:8000/hello/username in your browser. Enjoy!

Plugins overview

The list of some Muffin plugins (please make PR if you want to provide more):

Muffin-Jinja2

Jinja2 templates (asyncio/trio/curio)

Muffin-Session

Signed Cookie-Based HTTP sessions (asyncio/trio/curio)

Muffin-OAuth

Work with OAuth (authorization, resources loading) (asyncio/trio/curio)

Muffin-Sentry

Sentry integration (asyncio/trio/curio)

Muffin-Peewee

Peewee support (SQL, ORM) (asyncio/trio/curio)

Muffin-Babel

Localization support (asyncio/trio/curio)

Muffin-Databases

Work with SQL databases (asyncio only)

Muffin-Mongo

Work with Mongo DB (asyncio only)

Muffin-REST

The package provides enhanced support for writing REST APIs (asyncio/trio/curio)

Muffin-Redis

Redis support

Muffin-Admin

Automatically build Admin UI

Muffin-Prometheus

Prometheus metrics exporter

Benchmarks

You could find some tests here: http://klen.github.io/py-frameworks-bench/

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin/issues

Contributing

Development of The Muffin happens at: https://github.com/klen/muffin

Contributors

Muffin > 0.40 (completelly rewriten from scratch)

• Kirill Klenov

Muffin < 0.40 (based on AIOHTTP)

• Kirill Klenov

• Andrew Grigorev

• Diego Garcia

License

Licensed under a MIT license (See LICENSE)