Muffin is a fast, simple and asyncronous web-framework for Python 3 (asyncio, trio)
Project description
The Muffin
The framework has been created in 2015 when asyncio/aiohttp stack was very young and small. It was an attempt to build a foundation for asyncio web based project with all required tools (plugins system, admin interfaces, REST API and etc). For current moment (2018) aiohttp stack is quite good and the Muffin is depricated. It can be supported because some projects still use it but if you are planning to start a new project I would recomend to have a look on something else.
Muffin – A web framework based on Asyncio stack (depricated) Muffin is a fast, simple and asyncronous web-framework for Python 3.
Docs are available at https://muffin.readthedocs.org/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome.
Example “Hello User” with the Muffin:
import muffin
app = muffin.Application('example')
@app.route('/', '/hello/{name}')
async def hello(request):
name = request.path_params.get('name', 'anonymous')
return f'Hello {name.title()}!'Save the script as example.py and run it using Uvicorn (or another ASGI server):
$ uvicorn example:app
Open http://localhost:5000, http://localhost:5000/hello/username in your browser. Enjoy!
For a more complete example, see https://github.com/klen/muffin-example
Requirements
python >= 3.8
Installation
The Muffin should be installed using pip:
pip install muffin
Plugins
The list of some Muffin plugins (please make PR if you want to provide more):
Muffin-Jinja2 – Jinja2 templates
Muffin-Session – Signed Cookie-Based HTTP sessions
Muffin-OAuth – Work with OAuth (authorization, resources loading)
Muffin-Sentry – Sentry integration
Muffin-Peewee – Peewee support (SQL, ORM)
Muffin-Babel – Localization support
Muffin-Admin – Basic Admin interface
Muffin-DebugToolbar – Debug Toolbar
Muffin-Jade – Jade templates
Muffin-Metrics – Send metrics to Graphite/Statsd
Muffin-Mongo – MongoDB (pymongo) support
Muffin-Motor – MongoDB (motor) support
Muffin-REST – Helpers for building REST API
Muffin-Redis – Redis support
Benchmarks
You could find some tests here: http://klen.github.io/py-frameworks-bench/
Usage
See more in the example application sources. The application is deployed on Heroku: https://muffin-py.herokuapp.com
Run example server locally:
$ make -C example run
And open http://fuf.me:5000 in your browser.
Configuration
Muffin gets configuration options from python files. You have to specify default configuration module name in your app initialization:
app = muffin.Application('myapp', CONFIG='config.debug')This name could be overriden by MUFFIN_CONFIG environment variable:
$ MUFFIN_CONFIG=settings_local muffin example run
Which in its turn could be overriden by --config param of muffin command:
$ muffin --config=config.debug example run
Also you can define default config parameter values 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': ...
# Logging options
'ACCESS_LOG': '-', # File path to access log, - to stderr
'ACCESS_LOG_FORMAT': '%a %l %u %t "%r" %s %b "%{Referrer}i" "%{User-Agent}i"',
'LOG_LEVEL': 'WARNING'
'LOG_FORMAT': '%(asctime)s [%(process)d] [%(levelname)s] %(message)s'
'LOG_DATE_FORMAT': '[%Y-%m-%d %H:%M:%S %z]'
# Setup static files in development
'STATIC_PREFIX': '/static'
'STATIC_FOLDERS': ['static']Configuring logging
You can define your logging configurations with Python dictConfig format and place in LOGGING conf:
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'default': {
'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
},
},
'handlers': {
'logfile': {
'level': 'DEBUG',
'class': 'logging.handlers.RotatingFileHandler',
'filename': 'my_log.log',
'maxBytes': 50 * 1024 * 1024,
'backupCount': 10
},
},
'loggers': {
'': {
'handlers': ['logfile'],
'level': 'ERROR'
},
'project': {
'level': 'INFO',
'propagate': True,
},
}
}To use just get logger with logging.getLogger():
import logging
logger = logging.getLogger('project')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
Setup tests
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
Testing application
See examples:
async def test_async_code():
async def coro():
return True
assert await coro()
def test_app(app):
""" Get your app in your tests as fixture. """
assert app.name == 'my app name'
assert app.cfg.MYOPTION == 'develop'
async def test_view(client):
""" Make HTTP request to your application. """
async with client.get('/my-handler') as resp:
text = await resp.text()
assert 'mydata' in textAlso please check aiohttp testing documentation.
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
License
Licensed under a MIT license (See LICENSE)
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 Distributions
Built Distribution
File details
Details for the file muffin-0.46.4-py3-none-any.whl.
File metadata
- Download URL: muffin-0.46.4-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3ae7576ead2bd0788f5f933ca173ce5af5cb5cdcc6fb5cb4b617d2b266b1baf |
|
| MD5 | 9fd6102d44166b7fa3364d0bacc1b7a4 |
|
| BLAKE2b-256 | c2f5032506733edb5338751b107e3fab955c1fd2679bd86455d59658a2f9c19f |
