| Name | db-diagram JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | None |
| Summary | Create Database Entity Relationship Diagrams |
| upload_time | 2025-07-10 22:38:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.9 |
| license | None |
| keywords |
database
diagram
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# db-diagram
[](https://github.com/enorganic/db-diagram/actions/workflows/test.yml)
[](https://badge.fury.io/py/db-diagram)
This package provides a CLI and library for generating
[Mermaid Entity Relationship Diagrams
](https://mermaid.js.org/syntax/entityRelationshipDiagram.html)
based on an existing database [connection URL
](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) and/or
[SQLAlchemy metadata.
](https://docs.sqlalchemy.org/en/20/core/metadata.html)
- [Documentation](https://db-diagram.enorganic.org)
- [Contributing](https://db-diagram.enorganic.org/contributing)
- [Report a Bug](https://github.com/enorganic/db-diagram/issues)
## Installation
You can install `db-diagram` with pip:
```shell
pip3 install db-diagram
```
## Usage
You can utilize `db-diagram` as a
[CLI](https://db-diagram.enorganic.or/cli/) (from a shell or command prompt),
or as a [python library](https://db-diagram.enorganic.or/api/)
(`from db_diagram import write_markdown`).
The CLI will be more convenient under most circumstances, however
if you want to generate diagrams from [SQLAlchemy metadata
](https://docs.sqlalchemy.org/en/20/core/metadata.html) rather than
a connection URL, such as you might for a
[SQLAlchemy ORM](https://docs.sqlalchemy.org/en/latest/orm/),
you will want to use `db_diagram` as a python library.
Pease refer to [these examples](https://db-diagram.enorganic.or/examples/)
for reference concerning output.
Raw data
{
"_id": null,
"home_page": null,
"name": "db-diagram",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": "database, diagram",
"author": null,
"author_email": "david@belais.me",
"download_url": "https://files.pythonhosted.org/packages/9e/ec/7b8215bf323907126f4c0bd3226c5f9becf4caeea242f7bd0ffbb3e17561/db_diagram-0.0.0.tar.gz",
"platform": null,
"description": "# db-diagram\n\n[](https://github.com/enorganic/db-diagram/actions/workflows/test.yml)\n[](https://badge.fury.io/py/db-diagram)\n\nThis package provides a CLI and library for generating\n[Mermaid Entity Relationship Diagrams\n](https://mermaid.js.org/syntax/entityRelationshipDiagram.html)\nbased on an existing database [connection URL\n](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) and/or\n[SQLAlchemy metadata.\n](https://docs.sqlalchemy.org/en/20/core/metadata.html)\n\n- [Documentation](https://db-diagram.enorganic.org)\n- [Contributing](https://db-diagram.enorganic.org/contributing)\n- [Report a Bug](https://github.com/enorganic/db-diagram/issues)\n\n\n\n## Installation\n\nYou can install `db-diagram` with pip:\n\n```shell\npip3 install db-diagram\n```\n\n## Usage\n\nYou can utilize `db-diagram` as a\n[CLI](https://db-diagram.enorganic.or/cli/) (from a shell or command prompt),\nor as a [python library](https://db-diagram.enorganic.or/api/)\n(`from db_diagram import write_markdown`).\nThe CLI will be more convenient under most circumstances, however\nif you want to generate diagrams from [SQLAlchemy metadata\n](https://docs.sqlalchemy.org/en/20/core/metadata.html) rather than\na connection URL, such as you might for a\n[SQLAlchemy ORM](https://docs.sqlalchemy.org/en/latest/orm/),\nyou will want to use `db_diagram` as a python library.\nPease refer to [these examples](https://db-diagram.enorganic.or/examples/)\nfor reference concerning output.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Create Database Entity Relationship Diagrams",
"version": "0.0.0",
"project_urls": {
"Documentation": "https://db-diagram.enorganic.org",
"Repository": "https://github.com/enorganic/db-diagram"
},
"split_keywords": [
"database",
" diagram"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e681232fca239de176f10dfa2a1c79bfb50822009773d6c8f44728318009b280",
"md5": "d98962063bcc60607cdec628c5c5d31e",
"sha256": "88cb210c28034c671b370fc19f4592ef69898714a4ee5191c350d150235fb218"
},
"downloads": -1,
"filename": "db_diagram-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d98962063bcc60607cdec628c5c5d31e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9",
"size": 10808,
"upload_time": "2025-07-10T22:38:05",
"upload_time_iso_8601": "2025-07-10T22:38:05.459794Z",
"url": "https://files.pythonhosted.org/packages/e6/81/232fca239de176f10dfa2a1c79bfb50822009773d6c8f44728318009b280/db_diagram-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9eec7b8215bf323907126f4c0bd3226c5f9becf4caeea242f7bd0ffbb3e17561",
"md5": "3eacd7227fe6a33e66dbfdba3380f87f",
"sha256": "92da4394c897a35f3f0940139efa248727821bdd81ee9ea8407e5ba8374dd1a1"
},
"downloads": -1,
"filename": "db_diagram-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3eacd7227fe6a33e66dbfdba3380f87f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 9332,
"upload_time": "2025-07-10T22:38:06",
"upload_time_iso_8601": "2025-07-10T22:38:06.452083Z",
"url": "https://files.pythonhosted.org/packages/9e/ec/7b8215bf323907126f4c0bd3226c5f9becf4caeea242f7bd0ffbb3e17561/db_diagram-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 22:38:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "enorganic",
"github_project": "db-diagram",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "db-diagram"
}
