data-dictionary-builder 1.0.0__tar.gz

data_dictionary_builder-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Isaiah Johnson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data_dictionary_builder-1.0.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: data-dictionary-builder
+Version: 1.0.0
+Summary: Extract database metadata, generate dbt-compatible YAML, compare schemas, and deliver reports — all in a single Python import.
+Author-email: Isaiah Johnson <d8aguy@mail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/GraFreak0/data_dictionary_builder
+Project-URL: Repository, https://github.com/GraFreak0/data_dictionary_builder
+Project-URL: Issues, https://github.com/GraFreak0/data_dictionary_builder/issues
+Keywords: database,metadata,dbt,yaml,data-engineering,schema,documentation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: typing-extensions>=4.9.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: colorlog>=6.8.0
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.9; extra == "postgres"
+Provides-Extra: mysql
+Requires-Dist: PyMySQL>=1.1.0; extra == "mysql"
+Provides-Extra: clickhouse
+Requires-Dist: clickhouse-driver>=0.2.6; extra == "clickhouse"
+Provides-Extra: spanner
+Requires-Dist: google-cloud-spanner>=3.40.0; extra == "spanner"
+Provides-Extra: pdf
+Requires-Dist: reportlab>=4.0.0; extra == "pdf"
+Provides-Extra: email
+Requires-Dist: secure-smtplib>=0.1.1; extra == "email"
+Provides-Extra: all
+Requires-Dist: psycopg2-binary>=2.9.9; extra == "all"
+Requires-Dist: PyMySQL>=1.1.0; extra == "all"
+Requires-Dist: clickhouse-driver>=0.2.6; extra == "all"
+Requires-Dist: google-cloud-spanner>=3.40.0; extra == "all"
+Requires-Dist: reportlab>=4.0.0; extra == "all"
+Requires-Dist: secure-smtplib>=0.1.1; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.3; extra == "dev"
+Requires-Dist: black>=23.12.0; extra == "dev"
+Requires-Dist: flake8>=6.1.0; extra == "dev"
+Requires-Dist: mypy>=1.7.1; extra == "dev"
+Dynamic: license-file
+
+# Database Metadata Generator
+
+A Python library for extracting database metadata and generating dbt-compatible YAML files with schema comparison capabilities.
+
+## Features
+
+- Connect to multiple database types (SQLite, PostgreSQL, MySQL, ClickHouse, Spanner)
+- Extract complete schema metadata (tables, columns, data types, constraints)
+- Generate dbt-compatible YAML files (one per schema)
+- Compare source and destination database schemas
+- Email reporting for schema differences and missing descriptions
+- Airflow-compatible design for orchestration
+
+## Project Structure
+
+```
+data_dictionary_builder/
+├── README.md
+├── requirements.txt
+├── setup.py
+├── src/
+│   ├── __init__.py
+│   ├── connectors/
+│   │   ├── __init__.py
+│   │   ├── base.py
+│   │   ├── sqlite_connector.py
+│   │   ├── postgres_connector.py
+│   │   ├── mysql_connector.py
+│   │   ├── clickhouse_connector.py
+│   │   └── spanner_connector.py
+│   ├── metadata/
+│   │   ├── __init__.py
+│   │   ├── extractor.py
+│   │   └── models.py
+│   ├── yaml_generator/
+│   │   ├── __init__.py
+│   │   └── generator.py
+│   ├── comparison/
+│   │   ├── __init__.py
+│   │   └── comparator.py
+│   └── notifications/
+│       ├── __init__.py
+│       └── email_sender.py
+├── examples/
+│   ├── airflow_dag_example.py
+│   └── standalone_usage.py
+└── tests/
+    └── __init__.py
+```
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from data_dictionary_builder import MetadataExtractor, YAMLGenerator
+
+# Extract metadata
+extractor = MetadataExtractor(
+    db_type='postgres',
+    host='localhost',
+    port=5432,
+    database='mydb',
+    user='user',
+    password='pass'
+)
+
+metadata = extractor.extract_all_schemas()
+
+# Generate YAML files
+generator = YAMLGenerator(output_dir='./models')
+generator.generate_yaml_files(metadata)
+```
+
+### With Schema Comparison
+
+```python
+from data_dictionary_builder import SchemaComparator
+
+comparator = SchemaComparator(
+    source_config={...},
+    destination_config={...},
+    yaml_output_dir='./models'
+)
+
+report = comparator.compare_and_report(
+    email_to='team@example.com',
+    smtp_config={...}
+)
+```
+
+## Airflow Integration
+
+See `examples/airflow_dag_example.py` for complete DAG implementation.
+
+## Configuration
+
+Database connection configurations should include:
+- `db_type`: sqlite, postgres, mysql, clickhouse, spanner
+- `host`: Database host
+- `port`: Database port
+- `database`: Database name
+- `user`: Username
+- `password`: Password
+- Additional driver-specific parameters
+
+## License
+
+MIT License

data_dictionary_builder-1.0.0/README.md

@@ -0,0 +1,116 @@
+# Database Metadata Generator
+
+A Python library for extracting database metadata and generating dbt-compatible YAML files with schema comparison capabilities.
+
+## Features
+
+- Connect to multiple database types (SQLite, PostgreSQL, MySQL, ClickHouse, Spanner)
+- Extract complete schema metadata (tables, columns, data types, constraints)
+- Generate dbt-compatible YAML files (one per schema)
+- Compare source and destination database schemas
+- Email reporting for schema differences and missing descriptions
+- Airflow-compatible design for orchestration
+
+## Project Structure
+
+```
+data_dictionary_builder/
+├── README.md
+├── requirements.txt
+├── setup.py
+├── src/
+│   ├── __init__.py
+│   ├── connectors/
+│   │   ├── __init__.py
+│   │   ├── base.py
+│   │   ├── sqlite_connector.py
+│   │   ├── postgres_connector.py
+│   │   ├── mysql_connector.py
+│   │   ├── clickhouse_connector.py
+│   │   └── spanner_connector.py
+│   ├── metadata/
+│   │   ├── __init__.py
+│   │   ├── extractor.py
+│   │   └── models.py
+│   ├── yaml_generator/
+│   │   ├── __init__.py
+│   │   └── generator.py
+│   ├── comparison/
+│   │   ├── __init__.py
+│   │   └── comparator.py
+│   └── notifications/
+│       ├── __init__.py
+│       └── email_sender.py
+├── examples/
+│   ├── airflow_dag_example.py
+│   └── standalone_usage.py
+└── tests/
+    └── __init__.py
+```
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from data_dictionary_builder import MetadataExtractor, YAMLGenerator
+
+# Extract metadata
+extractor = MetadataExtractor(
+    db_type='postgres',
+    host='localhost',
+    port=5432,
+    database='mydb',
+    user='user',
+    password='pass'
+)
+
+metadata = extractor.extract_all_schemas()
+
+# Generate YAML files
+generator = YAMLGenerator(output_dir='./models')
+generator.generate_yaml_files(metadata)
+```
+
+### With Schema Comparison
+
+```python
+from data_dictionary_builder import SchemaComparator
+
+comparator = SchemaComparator(
+    source_config={...},
+    destination_config={...},
+    yaml_output_dir='./models'
+)
+
+report = comparator.compare_and_report(
+    email_to='team@example.com',
+    smtp_config={...}
+)
+```
+
+## Airflow Integration
+
+See `examples/airflow_dag_example.py` for complete DAG implementation.
+
+## Configuration
+
+Database connection configurations should include:
+- `db_type`: sqlite, postgres, mysql, clickhouse, spanner
+- `host`: Database host
+- `port`: Database port
+- `database`: Database name
+- `user`: Username
+- `password`: Password
+- Additional driver-specific parameters
+
+## License
+
+MIT License

data_dictionary_builder-1.0.0/pyproject.toml

@@ -0,0 +1,79 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "data-dictionary-builder"
+version = "1.0.0"
+description = "Extract database metadata, generate dbt-compatible YAML, compare schemas, and deliver reports — all in a single Python import."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Isaiah Johnson", email = "d8aguy@mail.com"}
+]
+keywords = ["database", "metadata", "dbt", "yaml", "data-engineering", "schema", "documentation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+# Core dependencies — always installed
+dependencies = [
+    "PyYAML>=6.0.1",
+    "python-dotenv>=1.0.0",
+    "click>=8.0.0",
+    "typing-extensions>=4.9.0",
+    "python-dateutil>=2.8.2",
+    "colorlog>=6.8.0",
+]
+
+[project.optional-dependencies]
+# Database connectors — install only what you need
+postgres    = ["psycopg2-binary>=2.9.9"]
+mysql       = ["PyMySQL>=1.1.0"]
+clickhouse  = ["clickhouse-driver>=0.2.6"]
+spanner     = ["google-cloud-spanner>=3.40.0"]
+
+# Reporting
+pdf         = ["reportlab>=4.0.0"]
+email       = ["secure-smtplib>=0.1.1"]
+
+# Install everything
+all = [
+    "psycopg2-binary>=2.9.9",
+    "PyMySQL>=1.1.0",
+    "clickhouse-driver>=0.2.6",
+    "google-cloud-spanner>=3.40.0",
+    "reportlab>=4.0.0",
+    "secure-smtplib>=0.1.1",
+]
+
+# Development tools
+dev = [
+    "pytest>=7.4.3",
+    "black>=23.12.0",
+    "flake8>=6.1.0",
+    "mypy>=1.7.1",
+]
+
+[project.urls]
+Homepage    = "https://github.com/GraFreak0/data_dictionary_builder"
+Repository  = "https://github.com/GraFreak0/data_dictionary_builder"
+Issues      = "https://github.com/GraFreak0/data_dictionary_builder/issues"
+
+[project.scripts]
+db-metadata-gen = "data_dictionary_builder.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

data_dictionary_builder-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+