Skip to main content

web framework based on Asyncio stack

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

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': [],

# 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!

Plugins

THe Muffin has a plugins support.

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)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

muffin-0.0.50.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

muffin-0.0.50-py2.py3-none-any.whl (16.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file muffin-0.0.50.tar.gz.

File metadata

  • Download URL: muffin-0.0.50.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for muffin-0.0.50.tar.gz
Algorithm Hash digest
SHA256 7d6395d49a32da29832f471ea4b36417db61a07a80a760962a02fed3d0b0f89f
MD5 c5fca0662037371ce45583ee36d0e8b3
BLAKE2b-256 c96c66df1643efec1dcba1212effe774b66fc5e5be941b89b7ed3d7976ed878c

See more details on using hashes here.

File details

Details for the file muffin-0.0.50-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for muffin-0.0.50-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3dae51fa74e67d5bdf860fe4c1777964a54cfdcd7c7f694288c564e8b3e613e5
MD5 9cfce138f1c56c8982d11781e5a7c02e
BLAKE2b-256 955d6100839b70122841f7a1b82a98ff8356b1f1ad3b639f4c886265e4b6381a

See more details on using hashes here.

Supported by

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