Skip to main content

Simple entity relation (ER) diagrams generation

Project description

Entity relation (ER) diagrams generator

=======================================



ERAlchemy is integrated with SQLAlchemy and is able to generate the ER

digram from an existing database.



Example

=======



.. figure:: https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/graph_example.png?raw=true

:alt: Example for a graph



Example for a graph



Quick Start

===========



Install

-------



To install ERAlchemy, just do



::



pip install eralchemy



``ERAlchemy`` requires

`GraphViz <http://www.graphviz.org/Download.php>`__ to generate the

graphs.



Use from python

---------------



.. code:: 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

============



.. figure:: https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/eralchemy_architecture.png?raw=true

:alt: Architecture schema



Architecture schema



Thanks to it's modular architecture, it can be connected to other

ORMs/ODMs/OGMs/O\*Ms.



Notes

=====



ERAlchemy was inspired by `erd <https://github.com/BurntSushi/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.14-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for ERAlchemy-0.0.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 866c2db3080198d7d94a26827e629a729417af83d76cd1aec0faab6c4462247a
MD5 3b426046bd3852ecffcbac2eef530b23
BLAKE2b-256 677c9e54f9851616e7955cc93583e1adae3d49862aeaaaa9d317684c3539c16d

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