Skip to main content

Use SQLAlchemy with CherryPy

Project description

CherryPy-SQLAlchemy makes it easy to use SQLAlchemy within CherryPy apps.


This package was primarily created from Sylvain’s SQLAlchemy recipe.

Basic Usage

There are two elements of CherryPy-SQLAlchemy

  1. A CherryPy tool that will create a session for use with each request.

  2. A CherryPy plugin that can maintains information about the database and binds the session to the specific DB.

Here is an example connecting to a sqlite db:

import cherrypy

from app import Root
from app.models import ORMBase
from cp_sqlalchemy import SQLAlchemyTool, SQLAlchemyPlugin

def run(): = SQLAlchemyTool()
    cherrypy.tree.mount(Root(), '/', {
        '/': {
            'tools.db.on': True

        cherrypy.engine, ORMBase, 'sqlite:////path/to/file.db'


One thin to note is the ORMBase we imported is sqlalchemy.ext.declarative.declarative_base() that was used when creating models.

From there, each request will have access to cherrypy.request.db, which is an instance of a SQLAlchemy session.

There is a more complete in the source.

  • Free software: BSD license

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

CherryPy-SQLAlchemy-0.5.3.tar.gz (3.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page