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 asyncio , aiohttp , web
Classifiers
Report project as malware

Project description

https://raw.github.com/klen/muffin/develop/logo.png

The Muffin

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

Plugins

The Muffin has a plugins support.

Usage

See sources of example application.

Run example server:

$ make run

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

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 muffin example run

Also you can define any options while initializing your application:

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

Base Muffin options and default values:

# Configuration module
'CONFIG': 'config'

# Enable debug mode
'DEBUG': False

# Logging options
'LOG_LEVEL': 'WARNING'
'LOG_FORMAT': '%(asctime)s [%(process)d] [%(levelname)s] %(message)s'
'LOG_DATE_FORMAT': '[%Y-%m-%d %H:%M:%S %z]'

# List of enabled plugins
'PLUGINS': []

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

CLI integration

Run in your shell:

$ muffin path.to.your.module:app_object_name --help
Write a custom command
@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

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

Deployment

Use muffin command. By example:

$ muffin example run --workers=4

See muffin {APP} run --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 MIT license (See LICENSE)

Supported by

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