Metadata-Version: 2.4
Name: arandu-broker
Version: 0.1.0
Summary: Small Python client for querying Arandu data through ADSS.
Author: Arandu
License: MIT
Project-URL: Homepage, https://github.com/cbpf/arandu-python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: adss
Requires-Dist: pandas>=2.0
Requires-Dist: requests>=2.28
Provides-Extra: cutouts
Requires-Dist: astropy>=5.0; extra == "cutouts"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"

# arandu

`arandu` is a compact Python interface to the Arandu broker data served by
ADSS. It returns query results as pandas DataFrames and keeps raw SQL
available when needed.

## Install

```bash
pip install -e '.[cutouts]'
```

## Quick start

```python
from arandu import AranduClient

client = AranduClient.from_env()
objects = client.objects(limit=100)
sources = client.sources(dia_object_id=12345)
```

Set `ARANDU_USERNAME` and `ARANDU_PASSWORD` before using `from_env()`. The
optional `ARANDU_ADSS_BASE_URL` defaults to `https://ai-scope.cbpf.br`.

```python
from arandu import download_cutout

image = download_cutout(alert, "science")
```

Cutouts require the `cutouts` extra. `alert` may contain a published URL at
`payload.cutouts`; otherwise the standard broker cutout URL is used.
