Metadata-Version: 2.3
Name: duckbricks-utils
Version: 0.1.0
Summary: DuckLake connection utilities for DuckBricks notebooks and pipelines
Author: DuckBricks Team
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: duckdb (>=1.3.0)
Requires-Dist: python-dotenv (>=1.0)
Description-Content-Type: text/markdown

# duckbricks-utils

DuckLake connection utilities for DuckBricks notebooks and pipelines.

## Installation

```bash
# From local path (development)
pip install /path/to/duckbricks-utils

# Once published to PyPI
pip install duckbricks-utils
```

## Usage

```python
from duckbricks_utils import connect

conn = connect()
result = conn.execute("SELECT * FROM my_table LIMIT 10").df()
```

## Configuration

Connection settings are read from environment variables:

| Variable | Default | Description |
|---|---|---|
| `DUCKLAKE_PG_HOST` | `localhost` | PostgreSQL host |
| `DUCKLAKE_PG_PORT` | `5432` | PostgreSQL port |
| `DUCKLAKE_PG_DATABASE` | `duckbricks` | PostgreSQL database name |
| `DUCKLAKE_PG_USER` | `duckbricks` | PostgreSQL user |
| `DUCKLAKE_PG_PASSWORD` | `duckbricks` | PostgreSQL password |
| `DUCKBRICKS_DUCKLAKE_NAME` | `duckbricks` | DuckLake catalog name |
| `DUCKBRICKS_DATA_PATH` | `/data/parquet/` | Parquet storage path |

