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


Download files

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

Source Distribution

erdammer-0.0.5.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

erdammer-0.0.5-py2.py3-none-any.whl (9.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file erdammer-0.0.5.tar.gz.

File metadata

  • Download URL: erdammer-0.0.5.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for erdammer-0.0.5.tar.gz
Algorithm Hash digest
SHA256 173bcc9eb41c331c90fb43d0752ffe2b59b80822d6202c1ec0f1a06e520a03d8
MD5 cf155d5f1df3264cb9afd413d657b233
BLAKE2b-256 484652c8b9ad8bd49acc83f5e6f01484188e7ca10ef7fb158a4e8c5ccc42ead1

See more details on using hashes here.

File details

Details for the file erdammer-0.0.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for erdammer-0.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 600d2cc88efa139fe29e65b2e47949d312bfe6a9acc7a33f0b3babbc96f7fdeb
MD5 c8a3aeb24c5e70c94f3085ceb2414246
BLAKE2b-256 10ca75fc98b1c6e2509e58bb0bc3362638ae1ea80f6d43a49363f7bf155ff57b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page