Skip to main content

Package to create ER diagrams from SQLAlchemy schemas using Graphviz.

Project description

SQLAlchemyViz

SQLAlchemyViz is a command line utility to create entity-relations diagrams from database schemas modeled with SQLAlchemy using Graphviz.

Requirements

Requires Graphviz installed on your machine and the SQLAlchemy and pydot packages.

License

SQLAlchemyViz is distributed under the MIT License.

Quickstart

Create an ER diagram from a sqlalchemy schema object.

positional arguments:
pkg.module:metadata Import path for the metadata identifier.
optional arguments:
-h, --help show this help message and exit
-f FILE, --file FILE
 Write diagram to specified file {default: diagram.pdf}.
-p PROG, --prog PROG
 Name of the graphviz layout program to use {default: “dot”}. Other choices are: “dot”, “twopi”, “circo” or “fdp”.
-o OPTION, --opt OPTION
 Where OPTION is e.g. “graph_bgcolor=red”. May be supplied multiple times.
-g GRAPHVIZ_PATH, --graphviz GRAPHVIZ_PATH
 Path to folder containing the graphviz executables.
-i INCLUDE_TABLES, --include INCLUDE_TABLES
 Include the given comma separated list of tables or classes. If omitted, create diagram for all.
-x EXCLUDE_TABLES, --exclude EXCLUDE_TABLES
 Exclude the given comma separated list of tables or classes.
--sort-columns Sort columns by whether they are primary or foreign keys and (case-insensitive) alphabetically.
--unique-relations
 Draw relations between tables only once (if multiple foreign keys reference the same table).
--show-constraints
 Show table constraints.
--max-cols MAX_COLS
 Limit amount of columns shown per table.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for SQLAlchemyViz, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size SQLAlchemyViz-0.4.tar.gz (7.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page