.. _Bottle: http://bottlepy.org/
==============================
Macaron for Web Applications
==============================
.. currentmodule:: macaron
Macaron in the Bottle
=====================
Macaron includes a plugin which simplifies the use of Bottle_ in your web applications. Bottle is a micro web framework for Python. To use it, simply, you just call :func:`bottle.install` with :class:`MacaronPlugin` instance. After that you use it the way you've always done it.
Each module of Macaron(ORM) and Bottle(Routing/Templates) consists of only a single file. So you can use a full-stack web framework by using only two files.
Example
=======
This is sample of using :class:`MacaronPlugin` in Bottle web application. And runnable sample is found at ``examples/bottle/`` in the source tree.
::
#!/usr/bin/env python
from bottle import *
import macaron
# install MacaronPlugin instance
DB_FILE = "bookmark.db"
install(macaron.MacaronPlugin(DB_FILE))
# Class definition
class Bookmark(macaron.Model): pass
# Route definition
@route("/hello")
def index():
html = "\nMy Bookmarks\n"
html += "\nMy Bookmarks
\n\n"
for bookmark in Bookmark.all():
html += '- %s
\n' % (bookmark.url, bookmark.title)
html += "
\n\n\n"
return html
if __name__ == "__main__":
run(host="localhost", port=8080)
MacaronPlugin class
===================
.. class:: MacaronPlugin(dbfile[, autocommit=True])
:param dbfile: database file name.
:param autocommit: Macaron will be commit automatically after execution of bottle.Route.
In this plugin, Macaron opens connection when :class:`Model` class is used (*Lazy* connection).