Metadata-Version: 2.0
Name: erdammer
Version: 0.0.5
Summary: Simple tool to generate database schema documentation
Home-page: https://github.com/vranac/erdammer
Author: Srdjan Vranac
Author-email: vranac@gmail.com
License: MIT
Keywords: erdammer
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: SQLAlchemy (==1.0.12)
Requires-Dist: click (==6.6)
Requires-Dist: mysql-connector-python-rf (==2.0.4)
Requires-Dist: pygraphviz (==1.3.1)

===============================
ERDammer
===============================

.. image:: https://img.shields.io/pypi/v/erdammer.svg
        :target: https://pypi.python.org/pypi/erdammer

.. image:: https://img.shields.io/pypi/l/erdammer.svg?maxAge=2592000
        :target: https://pypi.python.org/pypi/erdammer

.. image:: https://img.shields.io/pypi/pyversions/erdammer.svg?maxAge=2592000
        :target: https://readthedocs.org/projects/erdammer/?badge=latest



Simple tool to generate database schema documentation and export in svg, dot, rst or csv

Install
-------

.. code-block:: shell

    pip install erdammer

Usage
-----

Run `erdammer --help` for a list of options.

Things to note, to connect to the database you will have to supply a connection string uri.
For example

.. code-block:: mysql

    erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" -output="db-schema/" -format=svg

By default svg export creates a file called `erd.svg` in the directory you specified in output, in this
case it is `./db-schema`.

If on the other hand you execute

.. code-block:: mysql

    erdammer --uri "mysql+mysqlconnector://user:password@server/dbname" -output="db-schema/" -format=rst

One ReStructured file per table will be created, with table name as filename.

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage




