muffin 0.0.43

web framework based on Asyncio stack

The Muffin

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

Contents

• The Muffin

  • Requirements

  • Installation

  • Usage

    • Configuration

      • Base application options

    • CLI integration

      • Write a custom command

    • Templates (Jade)

    • Sessions

    • SQL (Peewee)

  • Testing

  • Deployment

  • Bug tracker

  • Contributing

  • Contributors

  • License

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 muffin example.app:app 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,

# List of enabled plugins
'PLUGINS': (
    'muffin.plugins.manage:ManagePlugin',
    'muffin.plugins.jade:JadePlugin',
    'muffin.plugins.peewee:PeeweePlugin',
    'muffin.plugins.session:SessionPlugin',
),

# Setup static files in development
'STATIC_PREFIX': '/static',
'STATIC_ROOT': '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.app 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.app hello mike --upper

    HELLO MIKE!

Templates (Jade)

Use jade.render in your handlers:

@app.view('/')
def hello(request):
    return (yield from app.plugins.jade.render(
        'index.jade', user=request.session.get('user', 'anonimous')))

The syntax is:

jade.render(TEMPLATE_NAME, **CUSTOM_CONTEXT)

Add default context provider:

@jade.ctx_provider
def my_context():
    """ Could be a coroutine. """
    return { ... }

Sessions

SQL (Peewee)

Migrations

• Create migrations:

  $ muffin example.app:app create [NAME]

• Run migrations:

  $ python example.app:app migrate [NAME]

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 muffin command. By example:

$ muffin example.app:app 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)