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.15-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for ERAlchemy-0.0.15-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 05be2a7843cbe6dd48647e4522b4a11d9f5b45655436a0a19b35de54fc8644cb
MD5 353db7b7d602da13bd4ed1ef3da95873
BLAKE2b-256 3644f7c0d826d8199b6e3870b434a85cdf5187a25c11bfaad3f3afb2b006d78a

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