Metadata-Version: 2.4
Name: dojosdk
Version: 0.1.0
Summary: Official Python client SDK for the Dojo API
Author: Dojo SDK Authors
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.23.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: typing-extensions>=4.0.0
Requires-Dist: anyio>=3.5.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: respx>=0.20.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Provides-Extra: huggingface
Requires-Dist: huggingface_hub>=0.20.0; extra == "huggingface"
Requires-Dist: pyarrow>=12.0.0; extra == "huggingface"
Requires-Dist: datasets; extra == "huggingface"
Dynamic: license-file

# DojoSDK

Official Python client SDK for the Dojo API.

## Installation

```bash
pip install dojosdk-0.1.0-py3-none-any.whl
```

## Quick Start

```python
import dojo

client = dojo.Dojo(api_key="your-api-key")
ticker = client.market_data.get_ticker(exchange="BINANCE", bz_type="spot", symbol="BTCUSDT")
print(ticker)
```

## Environment Variables

When integrating DojoSDK with Hugging Face Datasets (e.g., for automated data syncing or pushing records), you need to configure the following environment variable to authenticate with Hugging Face:

| Environment Variable | Description | Required |
| --- | --- | --- |
| `HF_TOKEN` | Hugging Face User Access Token. Requires "Write" permissions to push data to remote repositories. | **Yes** (when using `huggingface_hub` to push without CLI login) |

**Setup Example:**
```bash
export HF_TOKEN="hf_your_access_token_here"
```
Alternatively, you can skip configuring this variable if your environment is already authenticated locally via `huggingface-cli login`.
