Simple entity relation (ER) diagrams generation
Project description
Entity relation diagrams generator
==================================
|Join the chat at https://gitter.im/Alexis-benoist/eralchemy|
ERAlchemy generates Entity Relation (ER) diagram (like the one below)
from databases or from SQLAlchemy models.
Example
-------
.. figure:: https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/newsmeme.png?raw=true
:alt: Example for NewsMeme
Example for a graph
`Example for NewsMeme <https://bitbucket.org/danjac/newsmeme>`__
Quick Start
-----------
Install on a mac
~~~~~~~~~~~~~~~~
The simplest way to install eralchemy on OSX is by using
`Homebrew <http://brew.sh>`__
::
$ brew install eralchemy
Install
~~~~~~~
To install ERAlchemy, just do:
::
$ pip install eralchemy
``ERAlchemy`` requires
`GraphViz <http://www.graphviz.org/Download.php>`__ to generate the
graphs and Python. Both are available for Windows, Mac and Linux.
Usage from Command Line
~~~~~~~~~~~~~~~~~~~~~~~
>From a database
^^^^^^^^^^^^^^^
::
$ eralchemy -i sqlite:///relative/path/to/db.db -o erd_from_sqlite.pdf
The database is specified as a
`SQLAlchemy <http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls>`__
database url.
>From a markdown file.
^^^^^^^^^^^^^^^^^^^^^
::
$ curl 'https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/example/newsmeme.er' > markdown_file.er
$ eralchemy -i 'markdown_file.er' -o erd_from_markdown_file.pdf
>From a Postgresql DB to a markdown file excluding tables named ``temp`` and ``audit``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-tables temp audit
>From a Postgresql DB to a markdown file excluding columns named ``created_at`` and ``updated_at`` from all tables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-columns created_at updated_at
>From a Postgresql DB to a markdown file for the schema ``schema``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -s schema
Usage from Python
~~~~~~~~~~~~~~~~~
.. code:: 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')
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.
Contribute
----------
Every feedback is welcome on the `GitHub
issues <https://github.com/Alexis-benoist/eralchemy/issues>`__.
To run the tests, use : ``$ py.test``. Some tests require a local
postgres database with a schema named test in a database named test all
owned by a user named postgres with a password of postgres.
All tested PR are welcome.
Notes
-----
ERAlchemy was inspired by `erd <https://github.com/BurntSushi/erd>`__,
though it is able to render the ER diagram directly from the database
and not just only from the ``ER`` markup language.
Released under an Apache License 2.0
Creator: Alexis Benoist
`Alexis_Benoist <https://twitter.com/Alexis_Benoist>`__
.. |Join the chat at https://gitter.im/Alexis-benoist/eralchemy| image:: https://badges.gitter.im/Alexis-benoist/eralchemy.svg
:target: https://gitter.im/Alexis-benoist/eralchemy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
==================================
|Join the chat at https://gitter.im/Alexis-benoist/eralchemy|
ERAlchemy generates Entity Relation (ER) diagram (like the one below)
from databases or from SQLAlchemy models.
Example
-------
.. figure:: https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/newsmeme.png?raw=true
:alt: Example for NewsMeme
Example for a graph
`Example for NewsMeme <https://bitbucket.org/danjac/newsmeme>`__
Quick Start
-----------
Install on a mac
~~~~~~~~~~~~~~~~
The simplest way to install eralchemy on OSX is by using
`Homebrew <http://brew.sh>`__
::
$ brew install eralchemy
Install
~~~~~~~
To install ERAlchemy, just do:
::
$ pip install eralchemy
``ERAlchemy`` requires
`GraphViz <http://www.graphviz.org/Download.php>`__ to generate the
graphs and Python. Both are available for Windows, Mac and Linux.
Usage from Command Line
~~~~~~~~~~~~~~~~~~~~~~~
>From a database
^^^^^^^^^^^^^^^
::
$ eralchemy -i sqlite:///relative/path/to/db.db -o erd_from_sqlite.pdf
The database is specified as a
`SQLAlchemy <http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls>`__
database url.
>From a markdown file.
^^^^^^^^^^^^^^^^^^^^^
::
$ curl 'https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/example/newsmeme.er' > markdown_file.er
$ eralchemy -i 'markdown_file.er' -o erd_from_markdown_file.pdf
>From a Postgresql DB to a markdown file excluding tables named ``temp`` and ``audit``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-tables temp audit
>From a Postgresql DB to a markdown file excluding columns named ``created_at`` and ``updated_at`` from all tables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-columns created_at updated_at
>From a Postgresql DB to a markdown file for the schema ``schema``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -s schema
Usage from Python
~~~~~~~~~~~~~~~~~
.. code:: 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')
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.
Contribute
----------
Every feedback is welcome on the `GitHub
issues <https://github.com/Alexis-benoist/eralchemy/issues>`__.
To run the tests, use : ``$ py.test``. Some tests require a local
postgres database with a schema named test in a database named test all
owned by a user named postgres with a password of postgres.
All tested PR are welcome.
Notes
-----
ERAlchemy was inspired by `erd <https://github.com/BurntSushi/erd>`__,
though it is able to render the ER diagram directly from the database
and not just only from the ``ER`` markup language.
Released under an Apache License 2.0
Creator: Alexis Benoist
`Alexis_Benoist <https://twitter.com/Alexis_Benoist>`__
.. |Join the chat at https://gitter.im/Alexis-benoist/eralchemy| image:: https://badges.gitter.im/Alexis-benoist/eralchemy.svg
:target: https://gitter.im/Alexis-benoist/eralchemy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ERAlchemy-1.2.1.tar.gz
(10.5 kB
view details)
Built Distribution
File details
Details for the file ERAlchemy-1.2.1.tar.gz.
File metadata
- Download URL: ERAlchemy-1.2.1.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d76c506a5bb75c035e566e99daf2f74d9e85b4a89ed777a51cf739ada73f1d0d |
|
| MD5 | 59e2189beb17f4390f048c556d6e5ce3 |
|
| BLAKE2b-256 | 32629bd32cd9bd546fb5f168fdcf236bedaffa215891a006e132185e2ef7af34 |
File details
Details for the file ERAlchemy-1.2.1-py2.py3-none-any.whl.
File metadata
- Download URL: ERAlchemy-1.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 14.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1c8a5b13e7036824049f1d7d20b1cedb80763077a61d15fca1f870724cdf5866 |
|
| MD5 | 25ca9307641ac867ea3b5bc1c0c81304 |
|
| BLAKE2b-256 | ee9eb917c51e1c5bb1fc5d0a48edfff5cae67a7996d063c03242d60b3508a3e1 |
