Skip to main content

schema2rst generates reST doc from database schema

Project description

schema2rst generates reST doc from database schema

Features

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

Setup

Use easy_install (or pip):

$ sudo easy_install schema2rst

Configuration

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

Usage

Execute schema2rst command:

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

Examples

You can see example at http://tk0miya.bitbucket.org/schema2rst/build/html/ .

Requirements

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

License

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for schema2rst, version 0.9.0
Filename, size File type Python version Upload date Hashes
Filename, size schema2rst-0.9.0.tar.gz (6.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page