flythings-dataspace-sdk 1.0.2

About The Project

This is the Python SDK of the Flythings Connector Project.

Build

pip install flythings-dataspace-sdk

Content

• Auth: This module includes all the authentication logic
• Connector: This module includes all the clients and services that interface with Flythings Connector
• Model: This module contains all the required EDC entities

Requirements

Dependencies

Runtime

Development

Authentication

Authentication is configured on the DataspaceClient, which is the central entry point for the SDK. It supports two authentication strategies: static token and credentials-based.

Note: Static tokens may expire during long-running operations. If your use case requires uninterrupted access, prefer credentials-based authentication, which handles token renewal automatically.

Static Token

from flythings_dataspace_sdk import DataspaceClient, TokenAuth

auth = TokenAuth(token="my-token")

client = DataspaceClient(
    base_url="https://sdk.api.url",
    auth=auth,
)

Credentials (Recommended)

from flythings_dataspace_sdk import DataspaceClient, BasicLoginAuth

auth = BasicLoginAuth(
    auth_base_url="https://sdk.auth.url",
    username="my-username",
    password="my-password",
)

client = DataspaceClient(
    base_url="https://sdk.api.url",
    auth=auth,
)

When using BasicLoginAuth, the client acquires and refreshes tokens automatically, ensuring requests remain authenticated without manual intervention.

An optional timeout (in seconds) can be passed to DataspaceClient:

from flythings_dataspace_sdk import DataspaceClient, TokenAuth

auth = TokenAuth(token="my-token")

client = DataspaceClient(base_url="my-base-url", auth=auth, timeout=10)

Environment Variables (Recommended for Production)

The SDK can be configured entirely via environment variables using the from_env() factory:

from flythings_dataspace_sdk import DataspaceClient

client = DataspaceClient.from_env()

The following variables are read automatically:

Usage

The DataspaceClient exposes all clients and services as attributes — no separate instantiation is needed.

DownloadService

download_service downloads the contents of an asset identified by a contract agreement. The response is returned as bytes.

Minimal usage — only agreement_id is required:

from flythings_dataspace_sdk import DataspaceClient, DownloadRequest

client = DataspaceClient.from_env()

file = client.download_service.download(
    DownloadRequest(agreement_id="a3fe7fee-b359-477c-ab9d-0f9671601bf4")
)

Note: You can retrieve the agreement_id from the web interface. Navigate to Contracts, select a contract for your desired asset, click View Details, and locate the Agreement ID in the Agreement section.

Full configuration — the following shows all available parameters with their defaults:

from flythings_dataspace_sdk import DataspaceClient, DownloadRequest

client = DataspaceClient.from_env()

file = client.download_service.download(
    DownloadRequest(
        agreement_id="a3fe7fee-b359-477c-ab9d-0f9671601bf4",
        transfer_type="HttpData-PUSH",
        data_address_type="HttpProxy",
        protocol="dataspace-protocol-http",
        context=["https://w3id.org/edc/connector/management/v0.0.1"],
    )
)

The default configuration assumes an HTTP-based transfer. For non-HTTP assets (e.g., S3, Azure Blob), adjust transfer_type, data_address_type, and protocol accordingly.