Skip to main content

Simple tool to generate database schema documentation

Project description

https://img.shields.io/pypi/v/erdammer.svg https://img.shields.io/pypi/l/erdammer.svg?maxAge=2592000 https://img.shields.io/pypi/pyversions/erdammer.svg?maxAge=2592000

Simple tool to generate database schema documentation and export in svg, dot, rst or csv

Install

pip install erdammer

Usage

Run erdammer –help for a list of options.

Things to note, to connect to the database you will have to supply a connection string uri. For example

erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" -output="db-schema/" -format=svg

By default svg export creates a file called erd.svg in the directory you specified in output, in this case it is ./db-schema.

If on the other hand you execute

erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" -output="db-schema/" -format=rst

One ReStructured file per table will be created, with table name as filename.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Release history Release notifications

This version

0.0.5

Download files

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

Files for erdammer, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size erdammer-0.0.5-py2.py3-none-any.whl (9.9 kB) File type Wheel Python version 2.7 Upload date Hashes View hashes
Filename, size erdammer-0.0.5.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

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