web framework based on Asyncio stack
Project description
The Muffin – A web framework based on Asyncio stack. (early alpha)
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
Base application options
Base Muffin options and default values:
# Configuration module
'CONFIG': 'config',
# Enable debug mode
'DEBUG': False,
# List of enabled plugins
'PLUGINS': (
'muffin.plugins.manage:ManagePlugin',
'muffin.plugins.jade:JadePlugin',
'muffin.plugins.peewee:PeeweePlugin',
'muffin.plugins.session:SessionPlugin',
),
# Setup static files in development
'STATIC_PREFIX': '/static',
'STATIC_ROOT': 'static',
CLI integration
Add the next lines to end of your application file:
if __name__ == '__main__':
app.plugins.manage()
Run in your shell:
$ python -m path.to.your.app.module --help
Write a custom command
@app.plugins.manage.command
def hello_world(option=None, boolean_options=False):
print('Hello world!')
Templates (Jade)
Use jade.render in your handlers:
@app.view('/')
def hello(request):
return (yield from app.plugins.jade.render(
'index.jade', user=request.session.get('user', 'anonimous')))
The syntax is:
jade.render(TEMPLATE_NAME, **CUSTOM_CONTEXT)
Add default context provider:
@jade.ctx_provider
def my_context():
""" Could be a coroutine. """
return { ... }
Sessions
SQL (Peewee)
Migrations
Create migrations:
$ python -m path.to.your.app create [NAME]
Run migrations:
$ python -m path.to.your.app migrate [NAME]
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 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 Distribution
Built Distribution
File details
Details for the file muffin-0.0.7.tar.gz.
File metadata
- Download URL: muffin-0.0.7.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 45f361b643c61e5ac843451cdb5e401eb33eb853d1a4d9723b468eea0723723a |
|
| MD5 | 45a4896842a8851334389550d37794e5 |
|
| BLAKE2b-256 | 037cf83d12e581e45e4f4f56f04467224df5a73018db959322c3ff91ed2a8060 |
File details
Details for the file muffin-0.0.7-py2.py3-none-any.whl.
File metadata
- Download URL: muffin-0.0.7-py2.py3-none-any.whl
- Upload date:
- Size: 23.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1344c3423844fca7dd9e427940641de73b91167d3ae76eba39a6172b67e33e4 |
|
| MD5 | 595aa5b58eef55e47b4b92fbf7341790 |
|
| BLAKE2b-256 | 4db44cca7d17ce43510b96416f2da02ad0375ea65ec9594a2982c616b850d93f |
