Skip to main content

Schema-to-diagram compiler for DBML and SQL — ASCII/Unicode ERDs from the command line

Project description

dbsketch

ASCII/Unicode ERD diagrams from DBML or SQL schemas — designed to look clean in READMEs, docstrings, and LLM prompts.

pip install dbsketch
dbsketch schema.sql
dbsketch schema.dbml

No Node.js installation required — a suitable runtime is downloaded automatically on first use.

Usage

dbsketch [options] <file>

Options:
  --no-types      Hide column types
  --no-columns    Show table names only
  --ascii         Use ASCII box-drawing (default: Unicode)
  --sql           Force SQL input mode (auto-detected from .sql extension)

Example

dbsketch schema.sql > docs/erd.txt

Web playground

Try it in the browser at dbsketch.dev.

More

Full documentation and source at github.com/jacobmpeters/dbsketch.

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

If you're not sure about the file name format, learn more about wheel file names.

dbsketch-0.1.0-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file dbsketch-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dbsketch-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dbsketch-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4a54e30c63c5bf263b7c91a3e39e2b91d100a68221424fe67524970d8411c85
MD5 25a609addbb728740c6f760dd9733b43
BLAKE2b-256 b7cb8279b45506903f56e28a945350b47ed1184d26104e1860c0579da08cf2a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbsketch-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on jacobmpeters/dbsketch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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