schema2rst从数据库模式生成rest文档
schema2rst的Python项目详细描述
schema2rst从数据库模式生成rest文档
功能
从数据库架构生成表定义文档。 schema2rst识别数据库对表和列的注释, 把它反映给医生。
设置
使用简易安装(或PIP):
$ sudo easy_install schema2rst
配置
使config.yaml连接数据库服务器。 这是mysql服务器的示例:
type: mysql db: sample host: localhost user: username passwd: passw0rd
类型参数是接受这些值:mysql、mysql+pymysql、postgresql
用法
执行schema2rst命令:
$ schema2rst -c config.yaml -o database.rst
要求
- python 2.6、2.7、3.2、3.3
- 炼金术
- 皮亚姆
- 六
- pymysql或mysql python(可选)
- psycopg2(可选)
许可证
apache许可证2.0