{"id":22211788,"url":"https://github.com/harborn-digital/eralchemy","last_synced_at":"2025-03-25T05:53:11.514Z","repository":{"id":99365268,"uuid":"340005580","full_name":"Harborn-digital/eralchemy","owner":"Harborn-digital","description":"Entity Relation Diagrams generation tool","archived":false,"fork":false,"pushed_at":"2021-02-18T13:53:49.000Z","size":1243,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-30T05:27:09.271Z","etag":null,"topics":["managed","team-engineering-3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Alexis-benoist/eralchemy","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Harborn-digital.png","metadata":{"files":{"readme":"readme.md","changelog":"newsmeme.png","contributing":null,"funding":null,"license":"LICENSE.md","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,"publiccode":null,"codemeta":null}},"created_at":"2021-02-18T09:55:39.000Z","updated_at":"2023-11-27T09:31:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1fc69f3-a036-42e8-bb6a-73552aee5386","html_url":"https://github.com/Harborn-digital/eralchemy","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harborn-digital%2Feralchemy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harborn-digital%2Feralchemy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harborn-digital%2Feralchemy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Harborn-digital%2Feralchemy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Harborn-digital","download_url":"https://codeload.github.com/Harborn-digital/eralchemy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245407763,"owners_count":20610232,"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":["managed","team-engineering-3"],"created_at":"2024-12-02T20:38:24.017Z","updated_at":"2025-03-25T05:53:11.482Z","avatar_url":"https://github.com/Harborn-digital.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Entity relation diagrams generator\n\n[![Join the chat at https://gitter.im/Alexis-benoist/eralchemy](https://badges.gitter.im/Alexis-benoist/eralchemy.svg)](https://gitter.im/Alexis-benoist/eralchemy?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nERAlchemy generates Entity Relation (ER) diagram (like the one below) from databases or from SQLAlchemy models.\n\n## Example\n\n![Example for a graph](https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/newsmeme.png?raw=true \"Example for NewsMeme\")\n\n[Example for NewsMeme](https://bitbucket.org/danjac/newsmeme)\n\n## Quick Start\n\n### Install on a mac\nThe simplest way to install eralchemy on OSX is by using [Homebrew](http://brew.sh)\n\n    $ brew install eralchemy\n\n### Install\nTo install ERAlchemy, just do:\n\n    $ pip install eralchemy\n\n`ERAlchemy` requires [GraphViz](http://www.graphviz.org/download) to generate the graphs and Python. Both are available for Windows, Mac and Linux.\n\n### Usage from Command Line\n\n#### From a database\n\n    $ eralchemy -i sqlite:///relative/path/to/db.db -o erd_from_sqlite.pdf\n\nThe database is specified as a [SQLAlchemy](http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls)\ndatabase url.\n\n#### From a markdown file.\n\n    $ curl 'https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/example/newsmeme.er' \u003e markdown_file.er\n    $ eralchemy -i 'markdown_file.er' -o erd_from_markdown_file.pdf\n\n#### From a Postgresql DB to a markdown file excluding tables named `temp` and `audit`\n\n    $ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-tables temp audit\n\n#### From a Postgresql DB to a markdown file excluding columns named `created_at` and `updated_at` from all tables\n\n    $ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -o filtered.er --exclude-columns created_at updated_at\n\n#### From a Postgresql DB to a markdown file for the schema `schema`\n\n    $ eralchemy -i 'postgresql+psycopg2://username:password@hostname:5432/databasename' -s schema\n\n### Usage from Python\n\n```python\nfrom eralchemy import render_er\n## Draw from SQLAlchemy base\nrender_er(Base, 'erd_from_sqlalchemy.png')\n\n## Draw from database\nrender_er(\"sqlite:///relative/path/to/db.db\", 'erd_from_sqlite.png')\n```\n\n## Architecture\n![Architecture schema](https://raw.githubusercontent.com/Alexis-benoist/eralchemy/master/eralchemy_architecture.png?raw=true \"Architecture schema\")\n\nThanks to it's modular architecture, it can be connected to other ORMs/ODMs/OGMs/O*Ms.\n\n## Contribute\n\nEvery feedback is welcome on the [GitHub issues](https://github.com/Alexis-benoist/eralchemy/issues).\n\nTo run the tests, use : `$ py.test`.\nSome tests require a local postgres database with a schema named test in a database\nnamed test all owned by a user named postgres with a password of postgres.\n\nAll tested PR are welcome.\n\n## Notes\n\nERAlchemy was inspired by [erd](https://github.com/BurntSushi/erd), though it is able to render the ER diagram directly\nfrom the database and not just only from the `ER` markup language.\n\nReleased under an Apache License 2.0\n\nCreator: Alexis Benoist [Alexis_Benoist](https://twitter.com/Alexis_Benoist)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharborn-digital%2Feralchemy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharborn-digital%2Feralchemy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharborn-digital%2Feralchemy/lists"}