{ "info": { "author": "Chintalagiri Shashank", "author_email": "shashank@chintal.in", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "SQLAlchemyViz Sphinx Extension\n==============================\n\nThis file provides a Sphinx extension to include an Entity-Relationship\ndiagram of SQLAlchemy metadata, generated by the\n`SQLAlchemyViz `_ package. This is\na highly unpolished extension which does almost no heavy lifting, and not\nportable across platforms. The SQLALchemyViz package converts the SQLAlchemy\nmetadata object into a dot file. The extension then uses POSIX/Linux tools\nvia python's subprocess mechanisms to improve the layout of the graph.\n\nTo achieve the same effect directly from the shell, the relevant commands would\nbe :\n\n.. code-block:: bash\n\n sqlaviz --unique-relations --show-constraints -f out.dot\n ccomps -x out.dot | dot | gvpack -array3 | neato -Tpng -n2 -o out.png\n\n\n.. note::\n\n Some metadata models make SQLAlchemyViz hit a bug in graphviz/dot. In\n order to work around this, the rendering commands have been switched\n in v0.2 to :\n\n .. code-block:: bash\n\n sqlaviz -p neato --unique-relations -f out.dot\n ccomps -x out.dot | dot | gvpack -array3 | neato -Tpng -n2 -o out.png\n\n This change will hopefully be rolled back at some point, once the\n underlying bugs have been resolved.\n\n.. note::\n\n Recent update(s) to SQLAlchemyViz / pydot creates a syntax error in the\n generated .dot file. This is worked around by changing the sqlaviz command\n in v0.3 to :\n\n .. code-block:: bash\n\n sqlaviz -p neato --unique-relations -o node_margin='\"0,0\"' -f out.dot\n\n\nInstallation & Usage\n--------------------\n\nThis extension can be installed from pypi :\n\n .. code-block:: bash\n\n pip install sphinxcontrib-sqlalchemyviz\n\nIn the .rst file where the table should appear, insert the Sphinx\ndirective provided by this module :\n\n .. code-block:: rest\n\n .. .. sqlaviz::\n :metadataobject: full.importable.path.of.metadata\n\nFor a basic usage example, see:\n\n:Python: https://github.com/chintal/tendril/blob/master/tendril/utils/db.py#L201\n:Generated: http://tendril.chintal.in/doc/apidoc/tendril.utils.db/#tendril.utils.db.metadata\n\n\nLicense\n-------\n\nThis Sphinx Extension is made available under the BSD 2-clause License. See\nthe LICENSE file for the full text.", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/chintal/sphinxcontrib-sqlalchemyviz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/chintal/sphinxcontrib-sqlalchemyviz", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-sqlalchemyviz", "package_url": "https://pypi.org/project/sphinxcontrib-sqlalchemyviz/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-sqlalchemyviz/", "project_urls": { "Download": "https://github.com/chintal/sphinxcontrib-sqlalchemyviz", "Homepage": "https://github.com/chintal/sphinxcontrib-sqlalchemyviz" }, "release_url": "https://pypi.org/project/sphinxcontrib-sqlalchemyviz/0.5/", "requires_dist": null, "requires_python": "", "summary": "Sphinx SQLAlchemyViz extension", "version": "0.5" }, "last_serial": 5631810, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "f7b439be07f394fa40b4b0beec3655ea", "sha256": "eeee5d2ec3ac6daebc36a0f89371562bbd2385356631d4c7242f9a93bc13a666" }, "downloads": -1, "filename": "sphinxcontrib_sqlalchemyviz-0.1-py2-none-any.whl", "has_sig": true, "md5_digest": "f7b439be07f394fa40b4b0beec3655ea", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 5851, "upload_time": "2016-01-09T19:44:44", "url": "https://files.pythonhosted.org/packages/dc/4d/c4210c059aae1adc644e94eff3be91134a9dd681b5128cd859df6be3f43a/sphinxcontrib_sqlalchemyviz-0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b159d43b3f9bb2b9fd51ff7bd8903fec", "sha256": "c62a11810f40aa17b0d7119c59e036fa2f602d0e18375b77b044722d1e8cec87" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.1.tar.gz", "has_sig": true, "md5_digest": "b159d43b3f9bb2b9fd51ff7bd8903fec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4285, "upload_time": "2016-01-09T19:44:32", "url": "https://files.pythonhosted.org/packages/29/a4/f96e605c8c11b8374a2f52a1e0ec6e4db8ba23e54eaaa81101e873a22ec9/sphinxcontrib-sqlalchemyviz-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "c7215456fb04d707c1b13b2fc2d61059", "sha256": "3ea81bf727892b3c67792275512aa1e5294b16e009b371bdd58433c89656ff3b" }, "downloads": -1, "filename": "sphinxcontrib_sqlalchemyviz-0.2-py2-none-any.whl", "has_sig": true, "md5_digest": "c7215456fb04d707c1b13b2fc2d61059", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 6548, "upload_time": "2016-01-10T00:45:18", "url": "https://files.pythonhosted.org/packages/e6/43/796063f842b311a6c72b0f706451f585fa0c1b762c9669d8de2aef38bd39/sphinxcontrib_sqlalchemyviz-0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c21025fb9f5ce2ee01945aa4788cc6e4", "sha256": "e692bd351c016a100557687af10f8e52b3a036c31bd1c83c8ff8aee4657ae3db" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.2.tar.gz", "has_sig": true, "md5_digest": "c21025fb9f5ce2ee01945aa4788cc6e4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4669, "upload_time": "2016-01-10T00:45:00", "url": "https://files.pythonhosted.org/packages/6d/9e/4256f57e31ea72cc18a69eb795ce64e6cb5bdd17dff4b659b32ab6d59dc3/sphinxcontrib-sqlalchemyviz-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "a399808effd5f590a90feee1e5083487", "sha256": "8fbe4ffbe9f62a84d2866323d70ed4d0e58cee88c6685287207b07a5e2ae4218" }, "downloads": -1, "filename": "sphinxcontrib_sqlalchemyviz-0.3-py2-none-any.whl", "has_sig": true, "md5_digest": "a399808effd5f590a90feee1e5083487", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 6764, "upload_time": "2017-03-19T23:13:24", "url": "https://files.pythonhosted.org/packages/9e/03/a9939cb2a66a28a7cfab2cbcb3a6d860dbc1a07ca59923b5bffb906434e6/sphinxcontrib_sqlalchemyviz-0.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae3d24f6b0a36f1d14fc06fc7ee00725", "sha256": "a20f5f6caa91a8abaa0b3198518a1696f62657b8114dfe023a77032469839dda" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.3.tar.gz", "has_sig": true, "md5_digest": "ae3d24f6b0a36f1d14fc06fc7ee00725", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4830, "upload_time": "2017-03-19T23:13:17", "url": "https://files.pythonhosted.org/packages/61/26/f91a261410724c7c0a60ac2f58db40813267d0a4f9469afd45da4221adf9/sphinxcontrib-sqlalchemyviz-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "e78f4f97ea44f2fbfc18bdf86901981e", "sha256": "e6cb95ff6ce4d075ef45d58cb01a985e2f4f64e77683df52d8e9dfcba3fbca1c" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.4.linux-x86_64.tar.gz", "has_sig": true, "md5_digest": "e78f4f97ea44f2fbfc18bdf86901981e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4867, "upload_time": "2019-08-04T22:41:47", "url": "https://files.pythonhosted.org/packages/a0/2c/966c66af574d6b0bf323b137461ecb6bfabf44efa7ea19792e0f82723e0a/sphinxcontrib-sqlalchemyviz-0.4.linux-x86_64.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "a7b49d4401c914a4e7af976365165de1", "sha256": "1f70273caa607a7b8ea72d28a7c4410fc325f4310a69c06037cc0187c15ae804" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.5.tar.gz", "has_sig": true, "md5_digest": "a7b49d4401c914a4e7af976365165de1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4760, "upload_time": "2019-08-04T22:47:11", "url": "https://files.pythonhosted.org/packages/a5/c8/8d1981adb238fc8de100e3e74552bd2cb448cd75a22350564527b3e70e04/sphinxcontrib-sqlalchemyviz-0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a7b49d4401c914a4e7af976365165de1", "sha256": "1f70273caa607a7b8ea72d28a7c4410fc325f4310a69c06037cc0187c15ae804" }, "downloads": -1, "filename": "sphinxcontrib-sqlalchemyviz-0.5.tar.gz", "has_sig": true, "md5_digest": "a7b49d4401c914a4e7af976365165de1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4760, "upload_time": "2019-08-04T22:47:11", "url": "https://files.pythonhosted.org/packages/a5/c8/8d1981adb238fc8de100e3e74552bd2cb448cd75a22350564527b3e70e04/sphinxcontrib-sqlalchemyviz-0.5.tar.gz" } ] }