Metadata-Version: 2.0
Name: ERAlchemy
Version: 0.0.14
Summary: Simple entity relation (ER) diagrams generation
Home-page: https://github.com/Alexis-benoist/eralchemy
Author: Alexis Benoist
Author-email: alexis.benoist@gmail.com
License: Apache License 2.0
Keywords: sql relational databases ER diagram render
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: SQLAlchemy
Requires-Dist: pygraphviz

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


