Quick Start

Get up and running with Tractus-X SDK in minutes.

Prerequisites

• Python 3.9 or higher
• pip package manager
• Basic understanding of Python and REST APIs

Installation

Install the Tractus-X SDK using pip:

Bash

pip install tractusx-sdk

For local library instalation (intended for development)

Bash

git clone https://github.com/eclipse-tractusx/tractusx-sdk.git
pip install -e .

Basic Usage

1. Import the SDK

Python

from tractusx_sdk.dataspace.services.connector.base_connector_provider import (
    BaseConnectorProviderService,
)

2. Initialize a Connector Client

Python

# Initialize connector provider service
connector = BaseConnectorProviderService(
    dataspace_version="jupiter",  # or "saturn" for newer connectors
    base_url="https://your-edc-connector.example.com",
    dma_path="/management",
    headers={
        "X-Api-Key": "your-api-key",
        "Content-Type": "application/json"
    }
)

3. Create Your First Asset

Python

# Create a simple data asset
asset = connector.create_asset(
    asset_id="my-first-asset",
    base_url="https://backend.example.com/api/data",
    dct_type="application/json",
    version="3.0"
)

print(f"Asset created: {asset['@id']}")

4. Query Assets

Python

# List all assets
response = connector.assets.get_all()
assets = response.json()
for asset in assets:
    print(f"Asset ID: {asset['@id']}")

Next Steps

Now that you have the basics down, explore:

• Tutorials: Step-by-step guides for common tasks
• API Reference: Detailed API documentation
• How-to Guides: Real-world use cases
• Core Concepts: Understanding the SDK architecture

Need Help?

• Check our GitHub repository
• Join the Matrix chat
• Browse discussions

Example Projects

Explore complete example projects in the examples/ directory of the repository:

• Dataspace Services: EDC connector integration examples
• Industry Services: DTR and submodel server examples
• Extensions: Custom notification API examples

NOTICE

This work is licensed under the CC-BY-4.0.

• SPDX-License-Identifier: CC-BY-4.0
• SPDX-FileCopyrightText: 2025, 2026 Contributors to the Eclipse Foundation
• SPDX-FileCopyrightText: 2025, 2026 Catena-X Automotive Network e.V.
• SPDX-FileCopyrightText: 2025, 2026 LKS Next
• SPDX-FileCopyrightText: 2025, 2026 Mondragon Unibertsitatea
• Source URL: https://github.com/eclipse-tractusx/tractusx-sdk