Skip to main content

Simple entity relation (ER) diagrams generation

Project description

ERAlchemy is integrated with SQLAlchemy and is able to generate the ER digram from an existing database.

Example

Example for a graph

Example for a graph

Quick Start

Install

To install ERAlchemy, just do:

$ pip install eralchemy

ERAlchemy requires GraphViz to generate the graphs.

Use from python

from eralchemy import draw_er
## Draw from SQLAlchemy base
draw_er(Base, 'erd_from_sqlalchemy.png')

## Draw from database
draw_er("sqlite:///relative/path/to/db.db", 'erd_from_sqlite.png')

Use from the command line

$ eralchemy -i sqlite:///relative/path/to/db.db -o erd_from_sqlite.png

Architecture

Architecture schema

Architecture schema

Thanks to it’s modular architecture, it can be connected to other ORMs/ODMs/OGMs/O*Ms.

Notes

Every feedback is feedback is welcome on the GitHub issues.

To run the tests please run: $ py.test.

ERAlchemy was inspired by erd.

Released under an Apache License 2.0

Creator: Alexis Benoist

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ERAlchemy-0.0.20-py2.py3-none-any.whl (8.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ERAlchemy-0.0.20-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ERAlchemy-0.0.20-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d5620ca65afdec7a857b99e92124120394060a2a7be4b50b7c6b39aba522f1bc
MD5 cabdcfb260b961ec569db09c94fbf529
BLAKE2b-256 ef4a0a8d89db7474acc6870b19ee54c28f170ab80edbf243efdc01071e6a8564

See more details on using hashes here.

Supported by

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