sqla2uml


Namesqla2uml JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/abilian/sqla2uml
SummaryConvert your SQLAlchemy models to UML diagrams (via PlantUML)
upload_time2023-03-28 10:07:41
maintainer
docs_urlNone
authorAbilian SAS
requires_python>=3.9,<4.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==============
SqlAlchemy2UML
==============


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

.. image:: https://img.shields.io/travis/sfermigier/sqla2uml.svg
        :target: https://travis-ci.com/sfermigier/sqla2uml

.. image:: https://readthedocs.org/projects/sqla2uml/badge/?version=latest
        :target: https://sqla2uml.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status



Usage
-----

Install as a development dependency in your project, then type `sqla2uml` for help::

    Usage: sqla2uml [OPTIONS]

    Options:
      -m, --module TEXT          Package to analyse (recursively)
      -o, --output TEXT          File to output result (defaults to stdout)
      -p, --properties           Include properties in diagrams 
      -x, --exclude TEXT         List of class names to exclude from diagram
      -d, --debug-level INTEGER  Debug level
      --help                     Show this message and exit.


* Free software: MIT license
* Documentation: https://sqla2uml.readthedocs.io. (not working yet)


Features
--------

* Generate UML diagrams from SQLAlchemy models.
* One must have PlantUML installed.
* More features / more flexibility to come later.


Development
-----------

* Pull-requests accepted.
* Participants must adhere to the Python COC (<https://www.python.org/psf/>)


Credits
-------

This package was created with Cruft_ and the `abilian/cookiecutter-abilian-python`_ project template.

.. _Cruft: https://github.com/cruft/cruft
.. _`abilian/cookiecutter-abilian-python`: https://github.com/abilian/cookiecutter-abilian-python


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/abilian/sqla2uml",
    "name": "sqla2uml",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Abilian SAS",
    "author_email": "sf@abilian.com",
    "download_url": "https://files.pythonhosted.org/packages/4f/d7/167b89707ed219406a9032ddc41748a27b0a0069c5dcc41e607694b9057f/sqla2uml-0.1.4.tar.gz",
    "platform": null,
    "description": "==============\nSqlAlchemy2UML\n==============\n\n\n.. image:: https://img.shields.io/pypi/v/sqla2uml.svg\n        :target: https://pypi.python.org/pypi/sqla2uml\n\n.. image:: https://img.shields.io/travis/sfermigier/sqla2uml.svg\n        :target: https://travis-ci.com/sfermigier/sqla2uml\n\n.. image:: https://readthedocs.org/projects/sqla2uml/badge/?version=latest\n        :target: https://sqla2uml.readthedocs.io/en/latest/?version=latest\n        :alt: Documentation Status\n\n\n\nUsage\n-----\n\nInstall as a development dependency in your project, then type `sqla2uml` for help::\n\n    Usage: sqla2uml [OPTIONS]\n\n    Options:\n      -m, --module TEXT          Package to analyse (recursively)\n      -o, --output TEXT          File to output result (defaults to stdout)\n      -p, --properties           Include properties in diagrams \n      -x, --exclude TEXT         List of class names to exclude from diagram\n      -d, --debug-level INTEGER  Debug level\n      --help                     Show this message and exit.\n\n\n* Free software: MIT license\n* Documentation: https://sqla2uml.readthedocs.io. (not working yet)\n\n\nFeatures\n--------\n\n* Generate UML diagrams from SQLAlchemy models.\n* One must have PlantUML installed.\n* More features / more flexibility to come later.\n\n\nDevelopment\n-----------\n\n* Pull-requests accepted.\n* Participants must adhere to the Python COC (<https://www.python.org/psf/>)\n\n\nCredits\n-------\n\nThis package was created with Cruft_ and the `abilian/cookiecutter-abilian-python`_ project template.\n\n.. _Cruft: https://github.com/cruft/cruft\n.. _`abilian/cookiecutter-abilian-python`: https://github.com/abilian/cookiecutter-abilian-python\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Convert your SQLAlchemy models to UML diagrams (via PlantUML)",
    "version": "0.1.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c14264f3db4f536cc0896782bc9980b84b8f63dc735b07c01cba5e6c84b88a4b",
                "md5": "243b9f7754cfa7845f23fefeda5051cf",
                "sha256": "fcbb4d025be8df3960e663e07a774a8868b3ec1ec4b7c6695135bbad1d14457f"
            },
            "downloads": -1,
            "filename": "sqla2uml-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "243b9f7754cfa7845f23fefeda5051cf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 5294,
            "upload_time": "2023-03-28T10:07:40",
            "upload_time_iso_8601": "2023-03-28T10:07:40.742309Z",
            "url": "https://files.pythonhosted.org/packages/c1/42/64f3db4f536cc0896782bc9980b84b8f63dc735b07c01cba5e6c84b88a4b/sqla2uml-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4fd7167b89707ed219406a9032ddc41748a27b0a0069c5dcc41e607694b9057f",
                "md5": "bff1acc7d748c96b8b456365741dfd60",
                "sha256": "b684284c6b65fb27c725eec58e2149d7fc21cfa35ee3757960be46cfb1dc1910"
            },
            "downloads": -1,
            "filename": "sqla2uml-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "bff1acc7d748c96b8b456365741dfd60",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 4834,
            "upload_time": "2023-03-28T10:07:41",
            "upload_time_iso_8601": "2023-03-28T10:07:41.977415Z",
            "url": "https://files.pythonhosted.org/packages/4f/d7/167b89707ed219406a9032ddc41748a27b0a0069c5dcc41e607694b9057f/sqla2uml-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-28 10:07:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "abilian",
    "github_project": "sqla2uml",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "sqla2uml"
}
        
Elapsed time: 0.05290s