Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!


schema2rst generates reST doc from database schema


Generates table definitions document from database schema. schema2rst recognizes your database comments on tables and columns, and reflect it to docs.


Use easy_install (or pip):

$ sudo easy_install schema2rst


Make config.yaml to connect your database server. This is example for MySQL Server:

type: mysql
db: sample
host: localhost
user: username
passwd: passw0rd

type parameter is accept these values: mysql, mysql+pymysql, postgresql


Execute schema2rst command:

$ schema2rst -c config.yaml -o database.rst


You can see example at .


  • Python 2.6, 2.7, 3.2, 3.3, 3.4
  • SQLAlchemy
  • PyYAML
  • Six
  • pymysql or MySQL-python (optional)
  • psycopg2 (optional)


Apache License 2.0

Recent activity

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.