• MySQL
• Oracle
• MSSQL

SQLAlchemy supported databases

• SQLite
• Postgresql
• Firebird
• Sybase
• Others, most of which support multiple DBAPIs

This project generates docx files

• Data Dictionary
• Database growth projection

TODO

• ERM Diagram
• Schema build script

It is required to have Python3 installed as well as the packages:

• setuptools
• wheel
• python-docx

Make sure you have the PIP package manager installed

apt install python-pip

Required packages

pip install -U setuptools
pip install -U wheel
pip install mysql-connector-python-rf
pip install python-docx
apt install python-pip
pip install python-docx
pip install cx_Oracle
pip install SQLAlchemy
pip install console-progressbar
pip install pymssql

To generate the documentation in a terminal execute

python dbdoc.py

Modify the dbdoc.py file to connect to your database

Go to the ./template/ folder and edit the files

• diccionario.docx
• proyeccion.docx

The generator will take the format and add the corresponding information. The generated files will be stored in ./output

Do not take the generated files as the deliverables, make sure you:

• Change the texts and what has to be changed
• Check spelling
• Complement or modify the generated texts