Skip to main content

Simple entity relation (ER) diagrams generation

Project description

ERAlchemy generates Entity Relation (ER) diagram (like the one below) from databases or from SQLAlchemy models.

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 render_er
## Draw from SQLAlchemy base
render_er(Base, 'erd_from_sqlalchemy.png')

## Draw from database
render_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 [@Alexis_Benoist](https://twitter.com/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 Distribution

ERAlchemy-0.0.26.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

ERAlchemy-0.0.26-py2.py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 2 Python 3

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