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 http://tk0miya.bitbucket.org/schema2rst/build/html/ .
- 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