Metadata-Version: 2.4
Name: SCUDO
Version: 0.1.3
Summary: Shared Core Utilities for DataHub Operations
Author: CNIC
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: pyarrow
Requires-Dist: adbc-driver-manager
Requires-Dist: adbc-driver-flightsql

# SCUDO — Shared Core Utilities for DataHub Operations

**SCUDO** (Shared Core Utilities for DataHub Operations) is a reusable Python
package that provides common utilities and core components used across
DataHub-related workflows.

It is designed to standardize how applications interact with external systems,
handle logging, and implement reusable operational patterns.

## Key Capabilities

- Modular architecture for reusable components
- Apache Doris integration via multiple client implementations
- Centralized and structured logging utilities
- Lightweight and easy to integrate into ETL/ELT pipelines

## Package Structure

- [scudo.doris](scudo/doris) - Clients for interacting with Apache Doris
- [scudo.utils](scudo/utils) - Shared utilities (e.g., logging)

## Installation

SCUDO is available on the Python Package Index [PyPI](https://pypi.org/project/SCUDO/).

Therefore, you can install SCUDO easily using the pip command:
```bash
pip install scudo
```

For a specific version, use:
```bash
pip install scudo==0.1.3
```

Once installed, you can verify the installation by running:
```python
import scudo
print(scudo.__version__)
```


<!-- 
## Usage Overview

```python
from scudo.doris.flightsql import DorisFlightSQLClient

with DorisFlightSQLClient(...) as flightsql:
    df = flightsql.query("SELECT * FROM table")
```

## Documentation

See the module-level documentation:

* `SCUDO.md` — Full API overview
* `DORIS.md` — Doris clients
* `UTILS.md` — Utility modules
-->

