dsms-sdk 4.0.0

Python SDK core-package for working with the Dataspace Management System (DSMS).

DSMS-SDK

Python SDK core-package for interacting with the Dataspace Management System (DSMS)

Installation

From PyPI

pip install dsms-sdk

From source

git clone [e-mail]:MI-FraunhoferIWM/dsms-python-sdk.git
cd dsms-python-sdk
pip install -e .

Usage

The SDK provides a general Python interface to a remote DSMS deployment, allowing users to access, store and link data in a DSMS instance easily and safely. The package provides the following main capabilities:

• Managing Knowledge-Items (KItems), which are data instances of an explicitly defined semantic class type (KType)
• Creating, updating and deleting meta data and properties, e.g. date, operator, material response data for a conducted tensile test
• Administrating authorship, contact information and supplementary information upon making changes or adding KItems
• Semantic annotation of KItems
• Conduct simple free-text searches within the DSMS instance including filters (e.g. limiting the search for certain materials) as well as a more experts-aware SPARQL interface
• Linking KItems to other KItems
• Linking Apps to KItems, triggererd, for example, during a file upload
• Performing simple file upload and download using attachments to KItems
• Export of a knowledge (sub) graph as common serializations (.ttl, .json)

Documentation

Please have a look at our documentation on readthedocs: https://dsms-python-sdk.readthedocs.io

Compatibility

Please take the compability of the SDK version with the DSMS version into account:

SDK Version	DSMS Version
<2.0.0	<2.0.0
>=2.0.0, <3.0.0	>=2.0.0, <3.0.0
>=3.0.0, <3.0.4	>=3.0.0, <3.0.5
>=3.0.4, <3.1.0	>=3.0.5, <3.1.0
>=3.1.0, <3.2.2	>=3.1.0, <3.2.1
>=3.2.2	>=3.2.1, <4.0.0
>=4.0.0	>=4.0.0

Tutorials

Please have a look at our tutorials on readthedocs:

• 1. Introduction
• 2. Creation
• 3. Updation
• 4. Deletion
• 5. Search
• 6. Apps

Or try our Jupyter Notebooks:

• 1. Introduction
• 2. Creation
• 3. Updation
• 4. Deletion
• 5. Search
• 6. Apps
• 7. KTypes

Authors

Matthias Büschelberger (Fraunhofer Institute for Mechanics of Materials IWM)

Yoav Nahshon (Fraunhofer Institute for Mechanics of Materials IWM)

Pablo De Andres (Fraunhofer Institute for Mechanics of Materials IWM)

Priyabrat Mishra (Fraunhofer Institute for Mechanics of Materials IWM)

Arjun Gopalakrishnan (Fraunhofer Institute for Mechanics of Materials IWM)

License

This project is licensed under the BSD 3-Clause. See the LICENSE file for more information.

Disclaimer

Copyright (c) 2014-2024, Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. acting on behalf of its Fraunhofer IWM.

Contact: Matthias Büschelberger