2025 Python Packaging Survey is now live!  Take the survey now

web framework based on Asyncio stack

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (MIT)
  • Author: Kirill Klenov
  • Tags django , flask , sqlalchemy , testing , mock , stub , mongoengine , data
Classifiers
Report project as malware

Project description

The Muffin – A web framework based on Asyncio stack. (early alpha)

Build Status Coverals http://img.shields.io/pypi/v/muffin.svg?style=flat-square http://img.shields.io/pypi/dm/muffin.svg?style=flat-square Donate

Requirements

  • python >= 3.3

Installation

The Muffin should be installed using pip:

pip install muffin

Usage

See sources of example application.

Run example server:

$ make run

Configuration

Muffin gets configuration options from python files. By default the package tries to load a configuration from config module (config.py).

There are few ways to redifine configuration module:

  • Set configuration module in your app initialization:

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

  • Set environment variable MUFFIN_CONFIG:

    $ MUFFIN_CONFIG=settings_local python -m example.app runserver

Also you can define any options while initializing your application:

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

When using gmuffin (see bellow):

$ gmuffin -c example.config.debug example.app:app

Sessions

Templates (Jade)

SQL (Peewee)

CLI integration

Testing

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.app:app

Deployment

Use gmuffin command. By example:

$ gmuffin --reload -w 4 example.app:app

See gmuffin --help for more info.

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

  • klen (Kirill Klenov)

License

Licensed under a BSD license.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page