Skip to main content

Visual data model editor for dbt projects

Project description

trellis Data

trellis Data

trellis is a lightweight, local-first app that connects conceptual and logical data modeling with how you actually build the warehouse today—dbt-core first, with a live canvas that stays aligned to your project.

Why trellis

Typical pain

  • ERDs live in separate tools and go stale on real projects.
  • Transformations drift from the story the business understands.
  • Stakeholders can’t see structure without wading through SQL and YAML.
  • “All-in-one” warehouse designers rarely meet teams where they are (dbt, git, the modern stack).

What you get with trellis

  • Small PyPI install, local web app — run it beside your dbt project; the canvas and model files (data_model.yml, dbt YAML) stay in version control, so names, relationships, and descriptions evolve like the rest of your code—not a one-off diagram export.
  • One place to see entities, fields, relationships, and descriptions—tied to your repo, not a dead export.
  • Conceptual view for names and meaning; Logical view for columns, types, and materialization detail—switch without losing context.
  • Greenfield: sketch entities and attributes, then push structured artifacts into dbt.
  • Brownfield: load what you already modeled in dbt, infer links from relationship tests, and push descriptions and tags back into the project.

What you can do

  • Visualize your data model — canvas layout, conceptual vs logical views, less manual “diagram maintenance.”
  • Work with your dbt project — point at manifest.json / catalog.json, keep the diagram honest, round-trip descriptions and tags, and generate relationship tests from drawn links.
  • Optional — Kimball-style modeling — classify facts and dimensions, sensible default placement, and a Bus Matrix when your team thinks in stars/snowflakes; you can stay on plain entities if you prefer.
  • Optional — business events & processes — capture events with 7W-style annotations and group them into processes; most useful for greenfield and dimensional workflows. Skip this entirely if it’s not your methodology.

Getting started

Install

pip install trellis-datamodel
# or: uv pip install trellis-datamodel

Run next to your dbt project

  1. cd /path/to/your/dbt-project
  2. trellis init — creates trellis.yml (point it at your dbt paths and artifacts).
  3. trellis run — opens http://localhost:8089 (use trellis run --help for port and config path).

Generate manifest.json and catalog.json with dbt docs generate in your dbt project so trellis can load models; without them, the UI may start but show no dbt-backed entities.

Install from source or hack on the app: see CONTRIBUTING.md.

Examples & walkthroughs

Short video walkthroughs:

Getting started Init, settings in the UI, conceptual vs logical, relationships, push to dbt.
dbt integration Link a project, mock data, bind entities to models, stay in sync with artifacts.
Documenting business processes Optional / experimental: events, 7Ws, processes—enable in config or UI first.

More narrative walkthroughs and context: full tutorial · general information.

Configuration

After trellis init, edit trellis.yml. Annotated options and defaults live in trellis.yml.example (paths, modeling style, optional lineage/exposures, entity guidance, prefixes, etc.).

You can also open /config in the app to edit settings in the browser (validated saves; see example file for field meanings).

Vision

trellis is built and tested around dbt-core today. The longer-term idea is to stay tool-agnostic—concepts outlive any one framework. Possible directions include dbt Fusion, Pydantic-flavored exports, or adapters for tools like SQLMesh or Bruin where it makes sense. For now, the focus is a great experience with dbt-core.

Contributing

Contributions welcome. Workflow, local dev, tests, and packaging: CONTRIBUTING.md. All contributors sign the CLA once per GitHub account—see CLA.md and the bot on your PR.

Acknowledgments

  • dbt-colibri for lineage-related capabilities that support trellis visualization.

License

trellis Datamodel is licensed under the GNU Affero General Public License v3.0. See NOTICE for a short summary of copyright and licensing.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

trellis_datamodel-0.14.8.tar.gz (951.2 kB view details)

Uploaded Source

Built Distribution

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

trellis_datamodel-0.14.8-py3-none-any.whl (993.6 kB view details)

Uploaded Python 3

File details

Details for the file trellis_datamodel-0.14.8.tar.gz.

File metadata

  • Download URL: trellis_datamodel-0.14.8.tar.gz
  • Upload date:
  • Size: 951.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for trellis_datamodel-0.14.8.tar.gz
Algorithm Hash digest
SHA256 8d5da9d5b2269d21b06723f768a3e548d702e0a3a863f2a404d6e85b5bce8a96
MD5 e000a427bf9aa2dd204eefe13cfffd58
BLAKE2b-256 bfbc14ce85ff06a94199433494f6c80c9c728f96914c1b1c0f156f287d2c4c24

See more details on using hashes here.

Provenance

The following attestation bundles were made for trellis_datamodel-0.14.8.tar.gz:

Publisher: publish.yml on timhiebenthal/trellis-datamodel

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

File details

Details for the file trellis_datamodel-0.14.8-py3-none-any.whl.

File metadata

File hashes

Hashes for trellis_datamodel-0.14.8-py3-none-any.whl
Algorithm Hash digest
SHA256 35025c3fb6735c8b79bffce73b41d75fe007989d20b871be60526571c46eec72
MD5 e8cba66cdf3cbd4bb6fdf169b5978b5f
BLAKE2b-256 aadbcaf4f45dd75ba3e3eaa216118d94b1ce7a623a61be99100ca45cc007191e

See more details on using hashes here.

Provenance

The following attestation bundles were made for trellis_datamodel-0.14.8-py3-none-any.whl:

Publisher: publish.yml on timhiebenthal/trellis-datamodel

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