Important

This Sofware is still in development. Please consult our Roadmap

Tractus-X Software Development KIT

Eclipse Tractus-X Software Development KIT - The Dataspace & Industry Foundation Libraries

A modular facade with generic microservices that allows you to "provide" and "consume" data from Catena-X with simplified APIs and methods.

It aims to provide a reference implementation for the various interactions between applications and services like the EDC, Digital Twin Registry and Submodel Service. Is the literal "tool box" you need to provide data and consume data, how you orchestrate it is then up to you and your use case.

This SDK will manage automatically the version updates from the EDC and the Digital Twin Registry, providing a "smart REST API middleware" that will be maintained by the community.

No specific use case logic will be configured here, only the bare minimum for interacting in a Dataspace and developing your own applications with this stack, based on the KITs which adopt the core data exchange functionalities, in concrete the following ones:

• Connector KIT
• Digital Twin KIT
• Industry Core KIT

An example of SDK that is already used in Tractus-X is the Portal Shared Components, however this SDK shall aim to be generic for every application.

Roadmap

The development roadmap is the same as the industry core hub.

February 3 2025     R25.06             R25.09          R25.12
Kickoff              MVP                Stable          NEXT            2026 -> Beyond
| ------------------> | ----------------> | -----------> |  ----------------> | 
                Data Provision     Data Consumption    IC-HUB             + KIT Use Cases
                     SDK                 SDK             + Integrate First
                                                           Use Case (e.g. DPP) (Another usage for the SDK)

What can you do with this SDK?

• You can create a frontend for your use case (with any technology) and consume the APIs.
• Also, you can create a backend in python and import the libraries.
• Furthermore, you can use this in a Jupyter notebook for example, or create your personal scripts for using the EDC, DTR and Submodel Service.
• It enables you to build your own use case logic over it, without needing to worry about versioning.
• Base yourself in the Industry Core Hub which provides you a "lighthouse" for using this SDK.

Applications that use this SDK

• Industry Core Hub:

  • Backend: An example of how to use the SDK dataspace & industry libaries in your application.
  • Frontend: An example of how to use the SDK API interfaces from each microservice.

• The use case add-ons from the IC-Hub will also use this!

• Open for more collaboration!

Why was this Tractus-X SDK Created?

Here you will find a design decision which was taken at the beginning of the industry core hub development:

Industry Core Hub Decision Record 0002

While developing the Industry Core Hub, in parallel we decided to create a SDK for Tractus-X.

Industry Core Hub Decision Record 0003 Create new Repository

Having a individual SDK repository, we are creating a reusable and modular middleware/library for all use cases and applications that want to easily interact with the Tractus-X Datapaces Components required for data provision and data consumption:

• Tractus-X Eclipse Dataspace Connector (EDC)
• Tractus-X Digital Twin Registry
• Simple Data Backend

And other core services like:

Additional Services:

• Discovery Services:

  • Discovery Finder
  • BPN Discovery
  • EDC Discovery

• Portal IAM/IDP

Our aim is to automate the target releases and compatibility with this systems using DevOps mechanisms.

High Level Architecture

Providing two reusable libraries:

• Dataspace Foundation Library
  • Enables your "bytes" data exchange using the EDC and the core services from Catena-X.
  • It provides tools for your exchange agnostic from your use case.
• Industry Foundation Library
  • Enables your data exchange using the dataspace foundation library but for the usage of Digital Twins in the Digital Twin Registry.

Industry Core Hub Example

You can use it to build you use case application how you want, based on the industry core foundation or not:

Dataspace Architecture Patterns

This SDK will be developed based and will follow the Dataspace & Industry Usage Patterns recommended in Eclipse Tractus-X sig-architecture

How to Get Involved

• Get onboarded: Getting started. Join the Eclipse Tractus-X open source community as a contributor!
• Attend the official community office hours and raise your issue!
• Attend our Industry Core Hub Weekly
• Join our Tractus-X SDK Matrix Chat

Found a bug?

👀 If you have identified a bug or want to fix an existing documentation, feel free to create a new issue at our project's corresponding GitHub Issues page

⁉️ Before doing so, please consider searching for potentially suitable existing issues.

🙋 Assign to yourself - Show others that you are working on this issue by assigning it to yourself.
To do so, click the cog wheel next to the Assignees section just to the right of this issue.

Discuss

📣 If you want to share an idea to further enhance the project, please feel free to contribute to the discussions, otherwise create a new discussion

Reporting a Security Issue

Please follow the Security Issue Reporting Guidelines if you come across any security vulnerabilities or concerns.

Licenses

• Apache-2.0 for code
• CC-BY-4.0 for non-code

---

Thank you for using Software Development KIT! If you have any questions or need further assistance, please feel free to reach out.