muffin 0.0.3

web framework based on Asyncio stack

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

Contents

• Requirements

• Installation

• Usage

  • Configuration

  • Sessions

  • Templates (Jade)

  • SQL (Peewee)

  • CLI integration

• 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 ./app.py runserver

Also you can define any options while initializing your application:

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

Sessions

Templates (Jade)

SQL (Peewee)

CLI integration

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.