Skip to main content

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

Project description

Ruff

DSP-TOOLS Documentation

DSP-TOOLS is a Python package with a command line interface that helps you interact with a DSP server. A DSP server is a remote server or a local machine where the DSP-API is running on.

To install the latest version, run:

pip3 install dsp-tools

To update to the latest version run:

pip3 install --upgrade dsp-tools

The two main tasks that DSP-TOOLS serves for are:

  • Create a project with its data model(s), described in a JSON file, on a DSP server
    In order to archive your data on the DaSCH Service Platform, you need a data model 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.
  • Upload data, described in an XML file, to a DSP server that has a project with a matching data model
    Sometimes, data is 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.

All functionalities of DSP-TOOLS revolve around these two basic tasks.

DSP-TOOLS provides the following functionalities:

  • 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 an XML file (bulk data import) and writes the mapping from internal IDs to IRIs into a local file.
  • New workflow for xmlupload:
  • dsp-tools resume-xmlupload resumes a previously interrupted xmlupload or ingest-xmlupload.
  • dsp-tools excel2json creates an entire JSON project file from a folder with Excel files in it.
    • dsp-tools excel2lists creates the "lists" section of a JSON project file from one or several Excel files. The resulting section can be integrated into a JSON project file and then be uploaded to a DSP server with dsp-tools create.
    • dsp-tools excel2resources creates the "resources" section of a JSON project file from an Excel file. The resulting section can be integrated into a JSON project file and then be uploaded to a DSP server with dsp-tools create.
    • dsp-tools excel2properties creates the "properties" section of a JSON project file from an Excel file. The resulting section can be integrated into a JSON project file and then be uploaded to a DSP server with dsp-tools create.
  • dsp-tools new-excel2json does the same as the old excel2json command, but the Excel format for the lists section has been adapted.
  • 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.
  • 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 start-stack / stop-stack assist you in running a DSP stack on your local machine.
  • dsp-tools template creates a template repository with a minimal JSON and XML file.
  • dsp-tools rosetta clones the most up to date rosetta repository, creates the data model and uploads the data.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dsp_tools-9.1.0.post3.tar.gz (8.3 MB view details)

Uploaded Source

Built Distribution

dsp_tools-9.1.0.post3-py3-none-any.whl (269.1 kB view details)

Uploaded Python 3

File details

Details for the file dsp_tools-9.1.0.post3.tar.gz.

File metadata

  • Download URL: dsp_tools-9.1.0.post3.tar.gz
  • Upload date:
  • Size: 8.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for dsp_tools-9.1.0.post3.tar.gz
Algorithm Hash digest
SHA256 d09823497fb418b9857e9e146d5c0531dc0c9e9e7766eaa0aa49f107c363e3cc
MD5 1feac8b27b714836c4d82cba0734e93a
BLAKE2b-256 ce4fd8b0a53bcc4cdd8b39a03c21df2f86160d7d42d7bd47681b9347058a13af

See more details on using hashes here.

File details

Details for the file dsp_tools-9.1.0.post3-py3-none-any.whl.

File metadata

File hashes

Hashes for dsp_tools-9.1.0.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 91a6a0ba7d3c6ff46fde84517203ac7dd75512c81d8c3190c4bdeb2a51c503e4
MD5 5b9465e8cdc40374973e9bce42b1a92a
BLAKE2b-256 dcdbbdff8235516752948e0c13976d140635f0f3800929f8c1fde0deebb02dfc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page