schema2rst从数据库模式生成reST文档
项目描述
schema2rst从数据库模式生成reST文档
特性
从数据库模式生成表格定义文档。schema2rst识别您的数据库中表和列的注释,并将其反映到文档中。
设置
使用easy_install(或pip)
$ sudo easy_install schema2rst
配置
创建config.yaml以连接您的数据库服务器。以下为MySQL服务器的示例
type: mysql db: sample host: localhost user: username passwd: passw0rd
type参数接受以下值:mysql, mysql+pymysql, postgresql
使用
执行schema2rst命令
$ schema2rst -c config.yaml -o database.rst
示例
您可以在http://tk0miya.bitbucket.org/schema2rst/build/html/查看示例。
要求
Python 2.6, 2.7, 3.2, 3.3
SQLAlchemy
PyYAML
Six
pymysql或MySQL-python(可选)
psycopg2(可选)
许可证
Apache License 2.0