Skip to content

PyPI version

DSP-TOOLS documentation

dsp-tools is a command line tool that helps you to interact with the DaSCH Service Platform server (DSP server).

In order to archive your data on the DaSCH Service Platform, you need a data model (ontology) that describes your data. The data model is defined in a JSON project definition file which has to be transmitted to the DSP server. If the DSP server is aware of the data model for your project, conforming data can be uploaded into the DSP repository.

Often, data is initially added in large quantities. Therefore, dsp-tools allows you to perform bulk imports of your data. In order to do so, the data has to be described in an XML file. dsp-tools is able to read the XML file and upload all data to the DSP server.

dsp-tools helps you with the following tasks:

  • dsp-tools create creates the project with its data model(s) on a DSP server from a JSON file.
  • dsp-tools get reads a project with its data model(s) from a DSP server and writes it into a JSON file.
  • dsp-tools xmlupload uploads data from a provided XML file (bulk data import) and writes the mapping from internal IDs to IRIs into a local file.
  • dsp-tools excel creates a JSON or XML file from one or several Excel files. The created data can either be integrated into an ontology or be uploaded directly to a DSP server with dsp-tools create.
  • dsp-tools excel2resources creates the ontology's resource section from an Excel file. The resulting section can be integrated into an ontology and then be uploaded to a DSP server with dsp-tools create.
  • dsp-tools excel2properties creates the ontology's properties section from an Excel file. The resulting section can be integrated into an ontology and then be uploaded to a DSP server with dsp-tools create.
  • dsp-tools id2iri takes an XML file for bulk data import and replaces referenced internal IDs with IRIs. The mapping has to be provided with a JSON file.
  • dsp-tools excel2xml transforms a data source to XML if it is already structured according to the DSP specifications.
  • The module excel2xml provides helper methods that can be used in a Python script to convert data from a tabular format into XML.
Last update: 2022-06-10