Awesome Open Source
Awesome Open Source
https://raw.github.com/klen/muffin/develop/docs/static/logo-h200.png

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

Tests Status Documentation Status PYPI Version Python Versions

Features

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

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.

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.
  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)

Tests Status PYPI Version

Muffin-Session

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

Tests Status PYPI Version

Muffin-OAuth

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

Tests Status PYPI Version

Muffin-Sentry

Sentry integration (asyncio/trio/curio)

Tests Status PYPI Version

Muffin-Peewee

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

Tests Status PYPI Version

Muffin-Babel

Localization support (asyncio/trio/curio)

Tests Status PYPI Version

Muffin-Databases

Work with SQL databases (asyncio only)

Tests Status PYPI Version

Muffin-Mongo

Work with Mongo DB (asyncio only)

Tests Status PYPI Version

Muffin-REST

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

Tests Status PYPI Version

Muffin-Redis

Redis support

Tests Status PYPI Version

Muffin-Admin

Automatically build Admin UI

Tests Status PYPI Version

Muffin-Prometheus

Prometheus metrics exporter

Tests Status PYPI Version

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://awesomeopensource.com/project/klen/muffin

Contributors

Muffin > 0.40 (completelly rewriten from scratch)

Muffin < 0.40 (based on AIOHTTP)

License

Licensed under a MIT license (See LICENSE)


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Python (1,123,251
Asyncio (1,591
Web Framework (758
Asgi (164
Related Projects