SQLAlchemyViz Sphinx Extension
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-sqlalchemyviz 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib-sqlalchemyviz-0.5.tar.gz | 4.8 kB | Without provenance | Details for sphinxcontrib-sqlalchemyviz-0.5.tar.gz |
Release files / sphinxcontrib-sqlalchemyviz-0.5.tar.gz
| Download URL | sphinxcontrib-sqlalchemyviz-0.5.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f70273caa607a7b8ea72d28a7c4410fc325f4310a69c06037cc0187c15ae804
|
|
BLAKE2b-256 checksum How to use checksums |
a5c88d1981adb238fc8de100e3e74552bd2cb448cd75a22350564527b3e70e04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.5
|
Security for sphinxcontrib-sqlalchemyviz 0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
