Metadata-Version: 2.4
Name: dataenginex
Version: 0.8.2
Summary: DataEngineX - Core framework for data engineering projects
Author-email: Jay <jayapal.myaka99@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Jay
        
        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.
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: email-validator>=2.3.0
Requires-Dist: fastapi>=0.135.1
Requires-Dist: httpx>=0.28.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: opentelemetry-api>=1.40.0
Requires-Dist: opentelemetry-exporter-otlp>=1.40.0
Requires-Dist: opentelemetry-instrumentation-fastapi>=0.61b0
Requires-Dist: opentelemetry-sdk>=1.40.0
Requires-Dist: prometheus-client>=0.24.1
Requires-Dist: pyarrow>=23.0.1
Requires-Dist: pydantic>=2.10.0
Requires-Dist: python-dotenv>=1.2.1
Requires-Dist: python-json-logger>=4.0.0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: structlog>=25.5.0
Requires-Dist: uvicorn>=0.42.0
Provides-Extra: cloud
Requires-Dist: boto3>=1.42.0; extra == 'cloud'
Requires-Dist: google-cloud-bigquery>=3.40.0; extra == 'cloud'
Requires-Dist: google-cloud-storage>=3.0.0; extra == 'cloud'
Description-Content-Type: text/markdown

# dataenginex

`dataenginex` is the core DataEngineX framework package for building observable, production-ready data and API services.

It provides:

- FastAPI application primitives and API extensions
- Middleware for structured logging, metrics, and tracing
- Data quality and validation utilities
- Lakehouse and warehouse building blocks (S3, GCS, BigQuery, Parquet)
- Reusable ML support modules for model-serving workflows

## Install

```bash
# Core (no web framework dependencies)
pip install dataenginex

# With FastAPI, middleware, auth, health checks
pip install dataenginex[api]

# With cloud storage backends
pip install dataenginex[s3]        # AWS S3 via boto3
pip install dataenginex[gcs]       # Google Cloud Storage
pip install dataenginex[bq]        # Google BigQuery
pip install dataenginex[cloud]     # All cloud storage (S3 + GCS)

# Everything
pip install dataenginex[all]
```

## Package Scope

`dataenginex` is the core library from the DEX monorepo. It is the only published package — applications and examples are built on top of it.

## Submodules

| Module | Requires Extra | Description |
|--------|---------------|-------------|
| `dataenginex.core` | — | Medallion architecture, schemas, quality gates, validators |
| `dataenginex.data` | — | Schema registry, data contracts, catalog |
| `dataenginex.lakehouse` | optional `[s3]` `[gcs]` `[bq]` | Storage backends (JSON, Parquet, S3, GCS, BigQuery), catalog, partitioning |
| `dataenginex.warehouse` | — | Warehouse layers, lineage tracking |
| `dataenginex.ml` | — | Model registry, vectorstore, LLM adapters, drift detection |
| `dataenginex.api` | `[api]` | Auth (JWT), health checks, error handling, pagination, rate limiting |
| `dataenginex.middleware` | `[api]` | Structured logging, Prometheus metrics, OpenTelemetry tracing |

## Quick Usage

```python
# Core — always available
from dataenginex.core import MedallionArchitecture, QualityGate
from dataenginex.data import SchemaRegistry
from dataenginex.ml import ModelRegistry

# API — requires pip install dataenginex[api]
from dataenginex.api import HealthChecker, AuthMiddleware, paginate
from dataenginex.middleware import configure_logging, configure_tracing

# Storage — requires the relevant extra
from dataenginex.lakehouse import JsonStorage, get_storage
storage = get_storage("file://./data")       # always works
storage = get_storage("s3://my-bucket")      # requires [s3]
storage = get_storage("gs://my-bucket")      # requires [gcs]
storage = get_storage("bq://my-project/ds")  # requires [bq]
```

## Source and Docs

- Repository: https://github.com/TheDataEngineX/DEX
- CI/CD guide: `docs/CI_CD.md`
- Release notes: `src/dataenginex/RELEASE_NOTES.md`
