Metadata-Version: 2.4
Name: signalzero-sdk
Version: 0.1.0
Summary: Official Python SDK for SIGNAL.ZERO
Author: SIGNAL.ZERO
License: UNLICENSED
Project-URL: Homepage, https://www.signalzero.ink
Project-URL: Documentation, https://www.signalzero.ink/doc
Project-URL: OpenAPI, https://www.signalzero.ink/openapi.json
Keywords: signalzero,signal-zero,web3,api,sdk
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: httpx<1,>=0.26
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"

# SIGNAL.ZERO Python SDK

Official Python SDK for SIGNAL.ZERO.

## Install

```bash
pip install signalzero-sdk
```

## Usage

### Public client (no API key)

```python
from signalzero_sdk import SignalZeroPublicClient

client = SignalZeroPublicClient(base_url="https://www.signalzero.ink")
status = client.wallet_status("0xYOUR_ADDRESS", chain_id=84532)
print(status)
```

### Partner client (server-side only)

```python
import os
from signalzero_sdk import SignalZeroPartnerClient

client = SignalZeroPartnerClient(
  base_url="https://www.signalzero.ink",
  api_key=os.environ["SIGNALZERO_API_KEY"],
)

history = client.wallet_history("0xYOUR_ADDRESS", limit=200)
print(history)
```

## Error handling

On API errors, the SDK raises `SignalZeroError` with `status_code` and `error` (the server error code).
