https://github.com/abilian/sqla2uml

Generate UML model from SQLAlchemy ORM models
https://github.com/abilian/sqla2uml

Last synced: 3 months ago
JSON representation

Generate UML model from SQLAlchemy ORM models

• Host: GitHub
• URL: https://github.com/abilian/sqla2uml
• Owner: abilian
• License: mit
• Created: 2022-01-19T20:44:29.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-02T10:38:14.000Z (about 1 year ago)
• Last Synced: 2024-06-29T21:23:13.875Z (5 months ago)
• Language: Python
• Size: 154 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• jimsghstars - abilian/sqla2uml - Generate UML model from SQLAlchemy ORM models (Python)

README

        
==============

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 ()

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