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

PyPI version

DSP-TOOLS documentation

DSP-TOOLS is a Python package with a command line interface that helps you interact with a DSP server. The DSP server you interact with can be on a remote server, or on your local machine. 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 of DSP-TOOLS' functionality revolves 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.
  • 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 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.

Project details


Release history Release notifications | RSS feed

This version

2.0.0

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-2.0.0.tar.gz (123.1 kB view details)

Uploaded Source

Built Distribution

dsp_tools-2.0.0-py3-none-any.whl (145.3 kB view details)

Uploaded Python 3

File details

Details for the file dsp_tools-2.0.0.tar.gz.

File metadata

  • Download URL: dsp_tools-2.0.0.tar.gz
  • Upload date:
  • Size: 123.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.16 Linux/5.15.0-1024-azure

File hashes

Hashes for dsp_tools-2.0.0.tar.gz
Algorithm Hash digest
SHA256 ae410a25a1fba8846f82b03484961731a4eb404321d90102ad20c2db8cf5bdb6
MD5 3a42130a74bd57c83b8cd20eafa142a5
BLAKE2b-256 18dd3eb15c3a28c03261c197b24876d7770c13005441ee5a62e138dbe2abc876

See more details on using hashes here.

File details

Details for the file dsp_tools-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: dsp_tools-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 145.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.16 Linux/5.15.0-1024-azure

File hashes

Hashes for dsp_tools-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a880a0ecf803394ca208e0da8582f2044aa31973a8922c6bcd16d8cf86e508f
MD5 9afd93122e18e3beade9bd752e8e092d
BLAKE2b-256 375b49964a874fefb5fcb5d2a5ad624151598f767933326102589196faaed6a2

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