dsp-tools 18.6.1

DSP-TOOLS is a Python package with a command line interface that helps you interact with a DaSCH service platform (DSP) server.

DSP-TOOLS Documentation

Installing dsp-tools

To install the latest version, run:

pip3 install dsp-tools

To update to the latest version run:

pip3 install --upgrade dsp-tools

🚨 If your Python version is older than ours, pip will silently install an outdated version of DSP-TOOLS.
DSP-TOOLS requires one of these Python versions:
The most recent version of DSP-TOOLS is

The dsp-tools package provides you with functionalities in the command line to interact with the DSP-API, both remote and locally. Additionally, it contains the xmllib which helps you construct the XML file required for a mass upload.

Where To Start?

dsp-tools provides you with the following core functionalities.

• Running a Local Stack: If you want to run your own DSP stack locally, take a look here.
• Data Modelling: There are several ways to create a data model with dsp-tools
  • Take a look at the technical specification for the JSON file.
  • Or take a look at our tool to convert Excel files into the JSON format.
  • You can create a data model on the DSP-APP. To re-use that data model on another server you can use the CLI command described here.
• Data for Mass-Upload:
  • If you want to create the XML file required for a mass-upload onto DSP, take a look at the xmllib.
  • You can find an in-depth explanation of our XML file format here. Please note, that we recommend to use the xmllib library to create the file as we will ensure interoperability between the DSP-API requirements and your input.
  • If you want to validate and upload your XML file take a look here. Please note, that only DaSCH employees are permitted to upload data on a production server.