{"id":22400147,"url":"https://github.com/scalefreecom/dbt-dbml-erd","last_synced_at":"2025-07-31T14:32:30.796Z","repository":{"id":112947326,"uuid":"574615637","full_name":"ScalefreeCOM/dbt-dbml-erd","owner":"ScalefreeCOM","description":"Python application to create Entity Relationship Diagrams in dbt projects.","archived":false,"fork":false,"pushed_at":"2024-02-20T13:28:00.000Z","size":1227,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-02-20T14:39:11.562Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScalefreeCOM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-12-05T17:44:02.000Z","updated_at":"2023-09-09T11:51:19.000Z","dependencies_parsed_at":"2024-02-20T14:48:53.074Z","dependency_job_id":null,"html_url":"https://github.com/ScalefreeCOM/dbt-dbml-erd","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScalefreeCOM%2Fdbt-dbml-erd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScalefreeCOM%2Fdbt-dbml-erd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScalefreeCOM%2Fdbt-dbml-erd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScalefreeCOM%2Fdbt-dbml-erd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScalefreeCOM","download_url":"https://codeload.github.com/ScalefreeCOM/dbt-dbml-erd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228257766,"owners_count":17892652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T08:11:33.522Z","updated_at":"2024-12-05T08:11:34.164Z","avatar_url":"https://github.com/ScalefreeCOM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dbt-dbml-erd\nA Python application that creates Entity Relationship Diagrams (ERDs) in dbt projects using the open-source dbml language and the [dbdocs](https://dbdocs.io/) tool for visualization.\n\nThe app requires the following artifacts to create the dbml file:\n- `manifest.json`\n- `catalog.json`\n\nIt should be noted that the information about relationships comes from the dbt relationships test and therefore the tool only works if these tests are implemented.\n\n## Installation\n\n1. Clone this repository to a folder and run:\n\n```\npip install src/\n```\n\nor install directly from git using the following command:\n\n```\npip install -U git+https://github.com/ScalefreeCOM/dbt-dbml-erd#subdirectory=src\n```\n\n2. Set up the dbdocs cli for diagram creation by following the [instructions here](https://dbdocs.io/docs)\n3. Test erdbt with the following command:\n\n```\nerdbt test/manifest.json test/catalog.json test.dbml test True\n```\n\n## Usage\n\nTo use this application in your project, run the `erdbt` command with the following parameters in order:\n\n1. Path to the dbt `manifest.json`\n2. Path to the dbt `catalog.json`\n3. Path to store the dbml file\n4. Name of the project on dbdocs.io\n5. `True` or `False` if you want to visualize the dbml file on dbdocs.io\n6. (optional) Name of your relationships test\n\nExample:\n\n```\nerdbt my_project/manifest.json my_project/catalog.json my_project/erd.dbml my_project_erd True my_project_relationships\n```\n\nThis command will generate an ERD file named `erd.dbml` in the `my_project` folder, using the `manifest.json` and `catalog.json` files also located in that folder. The ERD will be uploaded to dbdocs.io under the project name `my_project_erd` and using the relationships test named `my_project_relationships`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscalefreecom%2Fdbt-dbml-erd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscalefreecom%2Fdbt-dbml-erd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscalefreecom%2Fdbt-dbml-erd/lists"}