Free project hosting by

dbdoc: database schema documentation generator

Project summary and intent

DBdoc is a set of utilities which generate Javadoc-style HTML documentation for database schemas. It is written in Python.

The current release of this code can generate documentation for Oracle and PostgreSQL schemas by introspecting a running database instance. A java-style properties file can optionally be used to add human-readable descriptions of such schema elements as tables, columns and indexes.

The project defines a simple Python API for inspecting DB schemas. The included 'oraschema' and 'pgschema' modules are implementations of the API for Oracle and PostgreSQL respectively. Implementations of this schema for other databases would be very welcome!

System requirements

To use the latest release of DBdoc, you will need Python 1.5.2 or later, plus the requisites for your particular database:

• Oracle:
  • An Oracle instance to which you can connect
  • An Oracle DB module for your Python version; cx_Oracle is strongly recommended, but others, such as DCOracle and DCOracle2 are also supported.
• Postgres:
  • A PostgreSQL access library for your Python version; PyGreSQL, psycopg and PoPy are all supported.
  • A PostgreSQL database instance to which you can connect

Project resources

• Example output
• The schema API definition
• Released files
• SourceForge project page
• CVS access (also browsable online)
• dbdoc-interest mailing list (low volume, archived here)

The author

I am an independent software specialist; I recently decided to consolidate my activities on writing, applying and teaching OpenSource software. Despite intensive spells with C, C++ and Perl in days of yore, I currently favour Python, Ruby, Java and Erlang (in no particular order).

Feel free to send me e-mail using this form or directly to: stephen_purcell at yahoo dot com.

Some of my other projects (mostly using Python):

• PyUnit, the standard Python unit testing framework
• WebUnit a fledgling project concerning web testing
• PyServ, my hacky Python Servlet Engine
• JArgs, a command-line option parsing suite for Java
• CVSUtils, a set of release utilities for CVS-based projects

I am intermittently available for consulting and training engagements in various application areas and on various platforms; details available upon request. (IT recruiters will save time by not bothering to contact me.)