Dataerai Python SDK

Python client for the Dataerai transfer daemon.
Supports authenticated uploads, downloads, and metadata operations. The daemon is started automatically if it is not already running.

Requirements

Python ≥ 3.10
The dataerai binary must be installed and on PATH (or pass binary_path explicitly)
The user must be logged in via dataerai auth login before calling auth_status() / upload() / download()

Installation

pip install dataerai-sdk
# or, from source:
pip install -e sdk/python/

Quick start

from dataerai import DataeraiClient

with DataeraiClient(binary_path="/usr/local/bin/dataerai") as client:
    # Check auth
    status = client.auth_status()
    print(f"Logged in as {status.user_email}, token expires {status.expires_at}")

    # Upload a file
    result = client.upload(
        "/path/to/data.csv",
        title="My dataset",
        owner_type="project",
        owner_id="proj-abc123",
        on_progress=lambda p: print(f"  {p.percent:.0f}%  {p.rate_mbps:.1f} MB/s"),
    )
    print(f"Uploaded  asset_id={result.asset_id}  content_id={result.content_id}")

    # Download it back
    dl = client.download(result.asset_id, dest_dir="/tmp/downloads")
    for f in dl.files:
        print(f"  {f.local_path}  ({f.size:,} bytes)")

    # Read / update metadata
    meta = client.get_metadata(result.asset_id)
    updated = client.set_metadata(result.asset_id, title="My dataset v2", tags=["csv", "demo"])

API reference

`DataeraiClient(*, socket_path, binary_path, auto_start, start_timeout_s, request_timeout_s)`

Parameter	Default	Description
`socket_path`	`$DATAERAI_SOCKET` or `/run/user/<uid>/dataerai-transfer.sock`	Unix socket path
`binary_path`	`None`	Path to the `dataerai` binary (required for `auto_start`)
`auto_start`	`True`	Spawn the daemon if the socket does not exist
`start_timeout_s`	`10.0`	Seconds to wait for the daemon socket to appear
`request_timeout_s`	`30.0`	Per-request timeout in seconds

Use as a context manager (with DataeraiClient(...) as client:) for automatic cleanup, or call client.connect() / client.close() manually.

Methods

Method	Returns	Description
`auth_status()`	`AuthStatus`	Logged-in user and token expiry
`upload(local_path, *, title, owner_type, owner_id, ...)`	`UploadResult`	Upload a file; blocks until complete
`download(asset_id, dest_dir, ...)`	`DownloadResult`	Download latest asset content; blocks until complete
`get_metadata(asset_id)`	`AssetMetadata`	Retrieve asset metadata
`set_metadata(asset_id, **fields)`	`AssetMetadata`	Update metadata fields

`upload()` keyword arguments

Argument	Type	Description
`title`	`str`	Asset title (required)
`owner_type`	`str`	`"project"` or `"collection"` (required)
`owner_id`	`str`	Owner entity ID (required)
`description`	`str \| None`	Free-text description
`alias`	`str \| None`	Short identifier
`tags`	`list[str] \| None`	Tag list
`metadata`	`dict \| None`	Arbitrary key-value metadata
`collection_id`	`str \| None`	Collection to add the asset to
`chunk_size_mb`	`int \| None`	Override default 64 MiB chunk size
`on_progress`	`Callable[[ProgressEvent], None] \| None`	Progress callback
`transfer_timeout_s`	`float`	Max seconds to wait for completion (default 3600)

Progress events

@dataclass
class ProgressEvent:
    transfer_id: str
    bytes_done: int
    bytes_total: int
    chunk_index: int
    chunk_count: int
    rate_bps: float
    file_index: int
    file_name: str

    @property
    def percent(self) -> float: ...   # 0–100

    @property
    def rate_mbps(self) -> float: ...

Error types

Exception	When raised
`DaemonError(code, message)`	Daemon returned a coded error (see `code` attribute)
`DaemonTimeoutError`	Request or transfer exceeded the configured timeout
`ConnectionError`	Daemon disconnected unexpectedly

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dataerai_sdk-0.1.0.tar.gz (53.9 kB view details)

Uploaded Jun 18, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

dataerai_sdk-0.1.0-py3-none-any.whl (40.4 kB view details)

Uploaded Jun 18, 2026 Python 3

File details

Details for the file dataerai_sdk-0.1.0.tar.gz.

File metadata

Download URL: dataerai_sdk-0.1.0.tar.gz
Upload date: Jun 18, 2026
Size: 53.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.10.13

File hashes

Hashes for dataerai_sdk-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`dc7a32b46ac13af85e6791330db336aed1e312f9b8f8a27429f71fbf69aabbc0`
MD5	`a7971484d1b1d9c718f3962c7cb4009e`
BLAKE2b-256	`b7d41e8070a6d19b599749440a5d514aeefe52e8986c60a97bfc5e8194c2dfe0`

See more details on using hashes here.

File details

Details for the file dataerai_sdk-0.1.0-py3-none-any.whl.

File metadata

Download URL: dataerai_sdk-0.1.0-py3-none-any.whl
Upload date: Jun 18, 2026
Size: 40.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.10.13

File hashes

Hashes for dataerai_sdk-0.1.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`64130b95a1b5c9ec4f29e59b4b6e3d3787e22d43b9534d1aac4132c943b3d29b`
MD5	`b09046b75550ab4ef64d2b88f7a9ba1e`
BLAKE2b-256	`88f800f491d2cbd63a61f90ce4762f0d620edda749efbb0185f5c7f6efde41aa`