Skip to main content

db -> mermaid ER code

Project description

make-mermaid-swim-by-db

make mermaid ER code from db (python)

Require

  • Python3.10
  • sqlalchemy
  • mysqlclient
  • your (mysql)DB

usage

  • install
pip install DB2mermaid
  • use
from db2mermaid.db2mermaid import DB2Mermaid
    dm = DB2Mermaid()
    dm.init_db("user", "pasword", "127.0.0.1", "3306", "db_name")
    dm.generate()

then, you will get er.md

Output Sample of Skila

ref: https://downloads.mysql.com/docs/sakila-db.tar.gz

output sapmle

mermaid live editor

Caution ❗

this package is not full. It cannot generate table relation, can only generate table definition 😢. (And now, only mysql... 🤣)

Future

Make CLI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

DB2mermaid-1.0.3-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page