Skip to main content

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

Metadata

Release files for schema2rst 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for schema2rst 0.9.0
File Size Uploaded Provenance
schema2rst-0.9.0.tar.gz 6.4 kB Without provenance Details

Release files / schema2rst-0.9.0.tar.gz

Download URL schema2rst-0.9.0.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
43de499549a12e7bf376269755bc8818559972a6bcfaa4d1a2264ff72001705f
BLAKE2b-256 checksum
How to use checksums
1f9c50ac7ba7fddb2bed5178172ba1429a9f369d9eeb26de869829eee86d6396
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for schema2rst 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.9.0 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page