Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

ASGI_ compatible;
Support Asyncio_, Trio_ and Curio_ python async libraries;
Parse ASGI scope, get url, headers, cookies, read a request's data/json/form-data
Send HTTP (text, html, json, stream, file, http errors) responses
Work with WebSockets

.. _documentation:

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

.. _contents:

.. contents::

.. _requirements:

.. _installation:

Installation

The Muffin should be installed using pip: ::

pip install muffin

We recommend using the latest version of Python. Muffin supports Python 3.7 and newer.

Dependencies


These distributions will be installed automatically when installing **Muffin**.

* `ASGI-Tools`_ - ASGI_ Toolkit
* `Modconfig`_  - Simple hierarchic configuration manager

.. _ASGI-Tools: https://klen.github.io/asgi-tools/
.. _Modconfig: https://pypi.org/project/modconfig/

.. _quickstart:

Quickstart
----------

Example "Hello User" with the Muffin:

.. code-block:: python

    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!

.. TODO: Finish the general example
.. For a more complete example, see https://github.com/klen/muffin-example

.. _plugins:

Plugins overview
----------------

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

`Muffin-Jinja2  <https://github.com/klen/muffin-jinja2>`_

Jinja2 <https://jinja.palletsprojects.com/en/2.11.x/>_ templates (asyncio/trio/curio)

.. image:: https://github.com/klen/muffin-jinja2/workflows/tests/badge.svg :target: https://github.com/klen/muffin-jinja2/actions :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-jinja2 :target: https://pypi.org/project/muffin-jinja2/ :alt: PYPI Version

Muffin-Session <https://github.com/klen/muffin-session>_


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

.. image:: https://github.com/klen/muffin-session/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-session/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-session
    :target: https://pypi.org/project/muffin-session/
    :alt: PYPI Version


`Muffin-OAuth <https://github.com/klen/muffin-oauth>`_ 
```````````````````````````````````````````````````````

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

.. image:: https://github.com/klen/muffin-oauth/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-oauth/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-oauth
    :target: https://pypi.org/project/muffin-oauth/
    :alt: PYPI Version


`Muffin-Sentry  <https://github.com/klen/muffin-sentry>`_
`````````````````````````````````````````````````````````

Sentry integration (asyncio/trio/curio)

.. image:: https://github.com/klen/muffin-sentry/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-sentry/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-sentry
    :target: https://pypi.org/project/muffin-sentry/
    :alt: PYPI Version


`Muffin-Peewee  <https://github.com/klen/muffin-peewee>`_ 
``````````````````````````````````````````````````````````

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

.. image:: https://github.com/klen/muffin-peewee/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-peewee/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-peewee
    :target: https://pypi.org/project/muffin-peewee/
    :alt: PYPI Version


`Muffin-Babel   <https://github.com/klen/muffin-babel>`_
````````````````````````````````````````````````````````

Localization support (asyncio/trio/curio)

.. image:: https://github.com/klen/muffin-babel/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-babel/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-babel
    :target: https://pypi.org/project/muffin-babel/
    :alt: PYPI Version


`Muffin-Databases   <https://github.com/klen/muffin-databases>`_

Work with SQL databases (asyncio only)

.. image:: https://github.com/klen/muffin-databases/workflows/tests/badge.svg :target: https://github.com/klen/muffin-databases/actions :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-databases :target: https://pypi.org/project/muffin-databases/ :alt: PYPI Version

Muffin-Mongo <https://github.com/klen/muffin-mongo>_


Work with Mongo DB (asyncio only)

.. image:: https://github.com/klen/muffin-mongo/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-mongo/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-mongo
    :target: https://pypi.org/project/muffin-mongo/
    :alt: PYPI Version

`Muffin-REST    <https://github.com/klen/muffin-rest>`_ 
````````````````````````````````````````````````````````

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

.. image:: https://github.com/klen/muffin-rest/workflows/tests/badge.svg
    :target: https://github.com/klen/muffin-rest/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-rest
    :target: https://pypi.org/project/muffin-rest/
    :alt: PYPI Version

`Muffin-Redis   <https://github.com/klen/muffin-redis>`_

Redis support

.. image:: https://github.com/klen/muffin-redis/workflows/tests/badge.svg :target: https://github.com/klen/muffin-redis/actions :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/muffin-redis :target: https://pypi.org/project/muffin-redis/ :alt: PYPI Version

.. * Muffin-Admin <https://github.com/klen/muffin-admin>_ -- Basic Admin interface

.. .. image:: http://img.shields.io/travis/klen/muffin-admin.svg?style=flat-square .. :target: http://travis-ci.org/klen/muffin-admin

.. .. image:: http://img.shields.io/pypi/v/muffin-admin.svg?style=flat-square .. :target: https://pypi.python.org/pypi/muffin-admin

.. .. image:: https://img.shields.io/github/issues-raw/klen/muffin-admin.svg?style=flat-square .. :target: https://github.com/klen/muffin-admin/issues

.. * Muffin-DebugToolbar <https://github.com/klen/muffin-debugtoolbar>_ -- Debug Toolbar

.. .. image:: http://img.shields.io/travis/klen/muffin-debugtoolbar.svg?style=flat-square .. :target: http://travis-ci.org/klen/muffin-debugtoolbar

.. .. image:: http://img.shields.io/pypi/v/muffin-debugtoolbar.svg?style=flat-square .. :target: https://pypi.python.org/pypi/muffin-debugtoolbar

.. .. image:: https://img.shields.io/github/issues-raw/klen/muffin-debugtoolbar.svg?style=flat-square .. :target: https://github.com/klen/muffin-debugtoolbar/issues

.. * Muffin-Jade <https://github.com/klen/muffin-jade>_ -- Jade templates

.. .. image:: http://img.shields.io/travis/klen/muffin-jade.svg?style=flat-square .. :target: http://travis-ci.org/klen/muffin-jade

.. .. image:: http://img.shields.io/pypi/v/muffin-jade.svg?style=flat-square .. :target: https://pypi.python.org/pypi/muffin-jade

.. .. image:: https://img.shields.io/github/issues-raw/klen/muffin-jade.svg?style=flat-square .. :target: https://github.com/klen/muffin-jade/issues

.. * Muffin-Metrics <https://github.com/klen/muffin-metrics>_ -- Send metrics to Graphite/Statsd

.. .. image:: http://img.shields.io/travis/klen/muffin-metrics.svg?style=flat-square .. :target: http://travis-ci.org/klen/muffin-metrics

.. .. image:: http://img.shields.io/pypi/v/muffin-metrics.svg?style=flat-square .. :target: https://pypi.python.org/pypi/muffin-metrics

.. .. image:: https://img.shields.io/github/issues-raw/klen/muffin-metrics.svg?style=flat-square .. :target: https://github.com/klen/muffin-metrics/issues

.. _benchmarks:

Benchmarks

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

.. _usage:

.. Usage .. =====

.. See more in the example application sources. The application is deployed on Heroku: .. https://muffin-py.herokuapp.com

.. Run example server locally: ::

.. $ make -C example run

.. And open http://fuf.me:5000 in your browser.

.. TODO: move to docs .. Configuration .. -------------

.. Muffin gets configuration options from python files. You have to specify .. default configuration module name in your app initialization:

.. .. code-block:: python

.. app = muffin.Application('myapp', CONFIG='config.debug')

.. This name could be overriden by MUFFIN_CONFIG environment variable: ::

.. $ MUFFIN_CONFIG=settings_local muffin example run

.. Which in its turn could be overriden by --config param of muffin command: ::

.. $ muffin --config=config.debug example run

.. Also you can define default config parameter values while initializing your application:

.. .. code-block:: python

.. app = muffin.Application('myapp', DEBUG=True, ANY_OPTION='Here', ONE_MORE='Yes')

.. Base application options .. ^^^^^^^^^^^^^^^^^^^^^^^^

.. Base Muffin options and default values:

.. .. code-block:: python

    .. # Configuration module
    .. 'CONFIG': 'config'

    .. # Enable debug mode
    .. 'DEBUG': ...

    .. # Logging options
    .. 'ACCESS_LOG': '-',  # File path to access log, - to stderr
    .. 'ACCESS_LOG_FORMAT': '%a %l %u %t "%r" %s %b "%{Referrer}i" "%{User-Agent}i"',
    .. 'LOG_LEVEL': 'WARNING'
    .. 'LOG_FORMAT': '%(asctime)s [%(process)d] [%(levelname)s] %(message)s'
    .. 'LOG_DATE_FORMAT': '[%Y-%m-%d %H:%M:%S %z]'

    .. # Setup static files in development
    .. 'STATIC_PREFIX': '/static'
    .. 'STATIC_FOLDERS': ['static']

.. Configuring logging .. ^^^^^^^^^^^^^^^^^^^ .. You can define your logging configurations with Python dictConfig format <https://docs.python.org/3.4/library/logging.config.html#configuration-dictionary-schema>_ and place in LOGGING conf:

.. .. code-block:: python

.. LOGGING = {
    .. 'version': 1,
    .. 'disable_existing_loggers': False,
    .. 'formatters': {
        .. 'default': {
            .. 'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        .. },
    .. },
    .. 'handlers': {
        .. 'logfile': {
            .. 'level': 'DEBUG',
            .. 'class': 'logging.handlers.RotatingFileHandler',
            .. 'filename': 'my_log.log',
            .. 'maxBytes': 50 * 1024 * 1024,
            .. 'backupCount': 10
        .. },
    .. },
    .. 'loggers': {
        .. '': {
            .. 'handlers': ['logfile'],
            .. 'level': 'ERROR'
        .. },
        .. 'project': {
            .. 'level': 'INFO',
            .. 'propagate': True,
        .. },
    .. }
.. }

.. To use just get logger with logging.getLogger():

.. .. code-block:: python

.. import logging
.. logger = logging.getLogger('project')

.. CLI integration .. ---------------

.. Run in your shell: ::

.. $ muffin path.to.your.module:app_object_name --help

.. Write a custom command .. ^^^^^^^^^^^^^^^^^^^^^^

.. .. code-block:: python

.. @app.manage.command
.. def hello(name, upper=False):
    .. """ Write command help text here.

    .. :param name:  Write your name
    .. :param upper: Use uppercase

    .. """
    .. greetings = 'Hello %s!' % name
    .. if upper:
        .. greetings = greetings.upper()
    .. print(greetings)

.. ::

.. $ muffin example hello --help

    .. Write command help text here.

    .. positional arguments:
    .. name        Write your name

    .. optional arguments:
    .. -h, --help  show this help message and exit
    .. --upper     Enable use uppercase
    .. --no-upper  Disable use uppercase

.. $ muffin example hello mike --upper

    .. HELLO MIKE!

.. .. _testing:

.. Testing .. ========

.. Setup tests .. -----------

.. Set module path to your Muffin Application in pytest configuration file or use .. command line option --muffin-app.

.. Example: ::

.. $ py.test -xs --muffin-app example

.. Testing application .. -------------------

.. See examples:

.. .. code-block:: python

.. async def test_async_code():
    .. async def coro():
        .. return True

    .. assert await coro()

.. def test_app(app):
    .. """ Get your app in your tests as fixture. """
    .. assert app.name == 'my app name'
    .. assert app.cfg.MYOPTION == 'develop'

.. async def test_view(client):
    .. """ Make HTTP request to your application. """
    .. async with client.get('/my-handler') as resp:
        .. text = await resp.text()
        .. assert 'mydata' in text

.. Also please check aiohttp testing documentation <https://docs.aiohttp.org/en/stable/testing.html>_.

.. .. _deployment:

.. Deployment .. ==========

.. Use muffin command. By example: ::

.. $ muffin example run --workers=4

.. See muffin {APP} run --help for more info.

.. _bugtracker:

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:

Contributing

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

Contributors

Muffin > 0.40 (completelly rewriten from scratch)

Kirill Klenov <https://github.com/klen>_

Muffin < 0.40 (based on AIOHTTP_)

Kirill Klenov <https://github.com/klen>_
Andrew Grigorev <https://github.com/ei-grad>_
Diego Garcia <https://github.com/drgarcia1986>_

.. _license:

License

Licensed under a MIT license (See LICENSE)

.. _links:

.. _AIOHTTP: https://docs.aiohttp.org/en/stable/ .. _ASGI: https://asgi.readthedocs.io/en/latest/ .. _Asyncio: https://docs.python.org/3/library/asyncio.html .. _Curio: https://curio.readthedocs.io/en/latest/ .. _Python: http://python.org .. _Trio: https://trio.readthedocs.io/en/stable/index.html .. _klen: https://github.com/klen

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].

Stars: ✭ 538

Visit Git Page 🔗Visit User Page 🔗Visit Issues Page (0) 🔗