Sphinx SQLAlchemyViz extension
Project description
This file provides a Sphinx extension to include an Entity-Relationship diagram of SQLAlchemy metadata, generated by the SQLAlchemyViz package. This is a highly unpolished extension which does almost no heavy lifting, and not portable across platforms. The SQLALchemyViz package converts the SQLAlchemy metadata object into a dot file. The extension then uses POSIX/Linux tools via python’s subprocess mechanisms to improve the layout of the graph.
To achieve the same effect directly from the shell, the relevant commands would be :
sqlaviz --unique-relations --show-constraints <pkg.module:metadata> -f out.dot
ccomps -x out.dot | dot | gvpack -array3 | neato -Tpng -n2 -o out.pngInstallation & Usage
This extension can be installed from pypi :
pip install sphinxcontrib-sqlalchemyviz
In the .rst file where the table should appear, insert the Sphinx directive provided by this module :
.. .. sqlaviz:: :metadataobject: full.importable.path.of.metadata
For a basic usage example, see:
License
This Sphinx Extension is made available under the BSD 2-clause License. See the LICENSE file for the full text.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-sqlalchemyviz-0.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a20f5f6caa91a8abaa0b3198518a1696f62657b8114dfe023a77032469839dda |
|
| MD5 | ae3d24f6b0a36f1d14fc06fc7ee00725 |
|
| BLAKE2b-256 | 6126f91a261410724c7c0a60ac2f58db40813267d0a4f9469afd45da4221adf9 |
Hashes for sphinxcontrib_sqlalchemyviz-0.3-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8fbe4ffbe9f62a84d2866323d70ed4d0e58cee88c6685287207b07a5e2ae4218 |
|
| MD5 | a399808effd5f590a90feee1e5083487 |
|
| BLAKE2b-256 | 9e03a9939cb2a66a28a7cfab2cbcb3a6d860dbc1a07ca59923b5bffb906434e6 |
