kgaughan / dbkit

Taking some of the pain out of Python's DB-API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

dbkit

Documentation Status Tests

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(f"{counter}: {value}")

Overview

dbkit is intended to be used in circumstances where it is impractical or overkill to use an ORM such as 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

Development

The repos can be found on Github while the documentation can be found on Read the Docs.

About

Taking some of the pain out of Python's DB-API

License:MIT License


Languages

Language:Python 100.0%