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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file ERAlchemy-0.0.26.tar.gz.

File metadata

  • Download URL: ERAlchemy-0.0.26.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ERAlchemy-0.0.26.tar.gz
Algorithm Hash digest
SHA256 d6b114afe4109a9e2e74549f33d5e28da4207a4df4c2a0699aef207566ff1312
MD5 f696f0ff24dbefa3116f51d989360695
BLAKE2b-256 25a5c1eadcafb9b39343536ecd206d010867c39128ac17f37c2f57cf537e67e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ERAlchemy-0.0.26-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4ae0503f78d4e3c906c5617955e94f1f996116405d4f31d744d9149e812a3545
MD5 40ea372138e3869473c80406140ebec9
BLAKE2b-256 c42d95161e2eb814127b193e32f43ccbb9574fae8b2f2a23f59da7431691288e

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