Metadata-Version: 1.1
Name: muffin
Version: 0.0.3
Summary: web framework based on Asyncio stack
Home-page: https://github.com/klen/muffin
Author: Kirill Klenov
Author-email: horneds@gmail.com
License: MIT
Description: The Muffin
        ##########
        
        .. _description:
        
        The Muffin -- A web framework based on Asyncio stack. **(early alpha)**
        
        .. _badges:
        
        .. image:: http://img.shields.io/travis/klen/muffin.svg?style=flat-square
            :target: http://travis-ci.org/klen/muffin
            :alt: Build Status
        
        .. image:: http://img.shields.io/coveralls/klen/muffin.svg?style=flat-square
            :target: https://coveralls.io/r/klen/muffin
            :alt: Coverals
        
        .. image:: http://img.shields.io/pypi/v/muffin.svg?style=flat-square
            :target: https://pypi.python.org/pypi/muffin
        
        .. image:: http://img.shields.io/pypi/dm/muffin.svg?style=flat-square
            :target: https://pypi.python.org/pypi/muffin
        
        .. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square
            :target: https://www.gratipay.com/klen/
            :alt: Donate
        
        .. _contents:
        
        .. contents::
        
        .. _requirements:
        
        Requirements
        =============
        
        - python >= 3.3
        
        .. _installation:
        
        Installation
        =============
        
        **The Muffin** should be installed using pip: ::
        
            pip install muffin
        
        .. _usage:
        
        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 ./app.py runserver
        
        Also you can define any options while initializing your application: ::
        
            app = muffin.Application('myapp', DEBUG=True, ANY_OPTION='Here', ONE_MORE='Yes')
        
        Sessions
        --------
        
        Templates (Jade)
        ----------------
        
        SQL (Peewee)
        ------------
        
        CLI integration
        ---------------
        
        .. _bugtracker:
        
        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:
        
        Contributing
        ============
        
        Development of The Muffin happens at: https://github.com/klen/muffin
        
        
        Contributors
        =============
        
        * klen_ (Kirill Klenov)
        
        .. _license:
        
        License
        =======
        
        Licensed under a `BSD license`_.
        
        .. _links:
        
        .. _BSD license: http://www.linfo.org/bsdlicense.html
        .. _klen: https://github.com/klen
        
Keywords: django,flask,sqlalchemy,testing,mock,stub,mongoengine,data
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
