Skip to content

ScottSturdivant/eralchemy

 
 

Repository files navigation

Entity relation diagrams generator

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

Example

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

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

About

Entity Relation Diagrams generation tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.2%
  • Shell 0.8%