Skip to main content

web framework based on Asyncio stack

Project description

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 python -m example.app runserver

Also you can define any options while initializing your application:

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

When using gmuffin (see bellow):

$ gmuffin -c example.config.debug example.app:app

Sessions

Templates (Jade)

SQL (Peewee)

CLI integration

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

$ gmuffin --reload -w 4 example.app:app

See gmuffin --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 BSD 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.5.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

muffin-0.0.5-py2.py3-none-any.whl (19.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin-0.0.5.tar.gz
Algorithm Hash digest
SHA256 87bc5f7390833b34a6174bb58eb6999aa528d82dad4d0f41e7b58b40fea13a21
MD5 e67ca615ff1a3c529f00cbae1de32985
BLAKE2b-256 3c53893098e55d8e4628c76e84dfea83c89b1dca9194cef40d9c52e6a3225df0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for muffin-0.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 684bce40ee3734076dda85655d8d844c09b668087249e0e4af5fa0d3755517f0
MD5 ddec38e377129ee3376dbaff0bf52a69
BLAKE2b-256 a90150c2f9868011d18e4e40c28fdd45ee04cc4a7e9f5041423841c3ea15098b

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