CLI tool that reads a database schema and generates documentation using an LLM.
Project description
metadata-intelligence
CLI tool that connects to a database (PostgreSQL, MySQL, SQL Server, Snowflake, Databricks, or MongoDB), reads the schema, and uses an LLM to generate documentation automatically. No frontend. No manual input beyond a one-time setup wizard.
Install
pip install metadata-intelligence[postgres] # or [mysql] [sqlserver] [snowflake] [databricks] [mongodb] [all]
Run
metadata-intelligence
A wizard asks for your database type, connection details, LLM provider/key,
and output folder on every run — nothing is read from or written to a .env
file; answers live only in memory for that process.
Output
Generates data_dictionary.md, column_docs.json, an interactive ER diagram
(er_diagram.html/.png/.mmd), pii_report.md, an Excel workbook
(schema_documentation.xlsx), and Suggestion_Report.docx for suggested
keys/relationships.
Known system dependencies
- SQL Server requires an ODBC driver installed on the OS (not pip-installable).
- PNG export via
cairosvgrequireslibcairo2on Linux (apt install libcairo2); Windows installs typically bundle this already.
License
MIT — see LICENSE.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file metadata_intelligence-0.1.1.tar.gz.
File metadata
- Download URL: metadata_intelligence-0.1.1.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecc65f497bf8699d7395907988939760986788ffee3edeb0ea9622a01f7baf0e
|
|
| MD5 |
903d7fb1beda85877fbd2a263bd8c53d
|
|
| BLAKE2b-256 |
cc25e823a45d4b45f4d19d663ba0cbd123c00fb1c70fd75e7d5df2be6da11af5
|
File details
Details for the file metadata_intelligence-0.1.1-py3-none-any.whl.
File metadata
- Download URL: metadata_intelligence-0.1.1-py3-none-any.whl
- Upload date:
- Size: 1.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6bd6cc660ef5f5e17b4c8fc327f4da8d1a5847f456ea3cf44b8b8633b8be3825
|
|
| MD5 |
9a508596639f4e595541a21f98566b19
|
|
| BLAKE2b-256 |
39a236f8f959ae19d6c5423f3b546046f8dc95069e4c4a28629090ccc45fd896
|