Skip to main content

DojoSDK

Official Python client SDK for the Dojo API.

Installation

pip install dojosdk

Quick Start

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:

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.

Hugging Face Cache Management

DojoSDK automatically caches offline data downloaded from Hugging Face. To free up disk space by deleting older revisions and keeping only the latest version of the cached data, use the cleanup_cache method:

from dojo.datasource.huggingface import HuggingFaceDataSource

ds = HuggingFaceDataSource()
result = ds.cleanup_cache()

# Expected output format:
# {'freed_space': '3.0GB', 'details': {'AlphaDojo/dojo_stock_kline': '772.9M', ...}, 'message': 'Cache cleanup complete.'}
print(result)

Metadata

Release files for dojosdk 0.1.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for dojosdk 0.1.26
File Interpreter ABI Platform
dojosdk-0.1.26-py3-none-any.whl Python 3 none any Details

Release files / dojosdk-0.1.26-py3-none-any.whl

Download URL dojosdk-0.1.26-py3-none-any.whl
Size 63.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
479c4488751eea7243166547bb860d0305efc79aa2ae2293512033a34bf64cf9
BLAKE2b-256 checksum
How to use checksums
fad938aac34868de0bb6314eddd86f0e2b3e74559e32f5ff344a006ae4880ed6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.13

Release history Release notifications | RSS feed

0.1.31

1 release file

0.1.30

1 release file

0.1.29

1 release file

0.1.28

1 release file

0.1.27

1 release file

This release

0.1.26 This release

1 release file

0.1.25

1 release file

0.1.24

1 release file

0.1.23

1 release file

0.1.22

1 release file

0.1.21

1 release file

0.1.20

1 release file

0.1.18

1 release file

0.1.17

1 release file

0.1.16

1 release file

0.1.15

1 release file

0.1.14

1 release file

0.1.13

1 release file

0.1.12

1 release file

0.1.11

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page