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

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)

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.72.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

muffin-0.0.72-py2.py3-none-any.whl (18.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin-0.0.72.tar.gz
Algorithm Hash digest
SHA256 29d51d6eeffea7d0623b3bc31f513f728c9d9b9d83ea358a1074aaa3a177bc43
MD5 5d4b76a4dbf0299151fafcf00f9ec50f
BLAKE2b-256 c4c6edea4226c97b19bd0f62aa04a8337d8f5b05e770bbbf706ee9c96a8d0fbd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for muffin-0.0.72-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ce0391991361945b5c15dceb230b5d729e82cf02f91395a830529a5e722b4767
MD5 1c754c5d43e48ba0008d72aca5830cfe
BLAKE2b-256 f3c85cbe72d2eb29385fae3b749672e884f50f28d4ef5f2dec5b625b9aef4595

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