Permalink
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
70 lines (51 sloc) 2.24 KB
.. image:: https://api.travis-ci.org/kgaughan/dbkit.png?branch=master
:target: https://travis-ci.org/kgaughan/dbkit
**dbkit** is a library that abstracts away at least part of the pain
involved in dealing with `DB-API 2`_ compatible database drivers.
Here's an example::
from dbkit import connect, query
from contextlib import closing
import sqlite3
with connect(sqlite3, 'counters.db') as ctx, closing(ctx):
for counter, value in query('SELECT counter, value FROM counters'):
print "%s: %d" % (counter, value)
Overview
========
*dbkit* is intended to be used in circumstances where it is impractical
or overkill to use an ORM such as `SQLObject`_ or `SQLAlchemy`_, but it
would be useful to at least abstract away some of the pain involved in
dealing with the database.
Features:
- Rather than passing around database connections, statements are executed
within a database `context`_, thus helping to decouple modules that
interface with the database from the database itself and its connection
details.
- Database contexts contain references to the exceptions exposed by the
database driver, thus decoupling exception handling from the database
driver.
- Easier to use transaction handling.
- Easier iteration over resultsets.
- Connection pooling. In addition, any code using pooled connections has
no need to know connection pooling is in place.
- Query logging.
Non-aims:
- Abstraction of SQL statements. The idea is to get rid of the more
annoying but necessary boilerplate code involved in dealing with
`DB-API 2`_ drivers, not to totally abstract away SQL itself.
Installation
============
*dbkit* can be installed with either either pip_ (recommended)::
$ pip install dbkit
Or with easy_install_::
$ easy_install dbkit
Development
===========
The repos can be found on `Github <https://github.com/kgaughan/dbkit>`_ while
the documentation can be found on `Read the Docs
<http://dbkit.readthedocs.org/>`_.
.. _DB-API 2: http://www.python.org/dev/peps/pep-0249/
.. _SQLObject: http://sqlobject.org/
.. _SQLAlchemy: http://sqlalchemy.org/
.. _context: http://docs.python.org/library/contextlib.html
.. _pip: http://www.pip-installer.org/
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall