Skip to main content
Help us improve Python packaging – donate today!

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

Release history Release notifications

This version
History Node

0.9.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
schema2rst-0.9.0.tar.gz (6.4 kB) Copy SHA256 hash SHA256 Source None Dec 11, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page