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 welcome on the GitHub issues.

To run the tests, use : $ 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.21-py2.py3-none-any.whl (8.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for ERAlchemy-0.0.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d334cfd9c5c3f55f81d01e72b08fef9a640f679250d01b8a8272c0a5e2ffc467
MD5 0c31683e0541479137c13da51a410004
BLAKE2b-256 ff92b8653aa961ec052018d43beb140d0c0741d4ce966cdff7912c3c07ec5e7d

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