Metadata-Version: 2.4
Name: auros-protocol
Version: 1.0.0
Summary: Official Python SDK for the AUROS Protocol — RWA intelligence API
Project-URL: Homepage, https://getauros.com/developers
Project-URL: Documentation, https://getauros.com/developers/docs
Project-URL: Repository, https://github.com/getauros/auros
Author-email: AUROS <contact@getauros.com>
License-Expression: MIT
Keywords: api,auros,mica,rwa,tokenization
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Description-Content-Type: text/markdown

# auros-protocol (Python)

Official Python SDK for the [AUROS Protocol](https://getauros.com/developers).

## Install

```bash
pip install auros-protocol
```

Or from source:

```bash
cd packages/auros-protocol-python
pip install -e .
```

## Quickstart

```python
from auros import AurosProtocol

client = AurosProtocol(api_key="auros_pk_test_demo")

result = client.score(
    description="Retail warehouse Luxembourg €2.5M SPV professional investors"
)
print(result["score"], result["grade"], result["mica_classification"])
```

## Methods

| Method | Endpoint | Auth |
|--------|----------|------|
| `score(**fields)` | `POST /api/v1/score` | Bearer |
| `score_batch(**body)` | `POST /api/v1/score/batch` | Bearer |
| `products(**query)` | `GET /api/v1/products` | Bearer |
| `jurisdictions(**query)` | `GET /api/v1/jurisdictions` | Bearer |
| `checklist(**body)` | `POST /api/v1/checklist` | Bearer |
| `compare(**body)` | `POST /api/v1/compare` | Bearer |
| `status()` | `GET /api/v1/status` | None |
| `create_key(email)` | `POST /api/v1/keys` | None |

## Examples

```python
# Catalog
bonds = client.products(category="bonds", yield_min=4, limit=10)

# Jurisdictions
ranking = client.jurisdictions(
    asset_type="real_estate",
    investor_type="professional",
    timeline_months=6,
)

# Checklist
items = client.checklist(
    asset_type="real_estate",
    jurisdiction="luxembourg",
    structure="spv",
)

# Compare RWA products
comparison = client.compare(category="bonds", yield_min=4, limit=3)

# API health (no auth)
health = client.status()
print(health["status"], health["version"])

# Free API key
key_resp = client.create_key("you@company.com")
print(key_resp["api_key"])
```

## Context manager

```python
with AurosProtocol(api_key="auros_pk_test_demo") as client:
    print(client.score(description="..."))
```

## Disclaimer

Indicative intelligence only — not legal, tax, or investment advice.

## Publish (maintainers)

```bash
cd packages/auros-protocol-python
python -m pip install --upgrade build twine
python -m build
python -m twine upload dist/*
```

Set `TWINE_USERNAME=__token__` and `TWINE_PASSWORD=pypi-<your-api-token>` before upload.
