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 upload-files uploads all files that are referenced in an XML file to a DSP server.
- dsp-tools ingest-files kicks off the ingest process, and retrieves the mapping CSV when it is finished.
- dsp-tools ingest-xmlupload creates the resources contained in the XML file, using the mapping CSV
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 new-excel2lists does the same as the old excel2lists command, but the Excel format 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.

Metadata

Release files for dsp-tools 9.1.0.post12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dsp-tools 9.1.0.post12
File	Size	Uploaded	Provenance
dsp_tools-9.1.0.post12.tar.gz	8.3 MB	Oct 7, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for dsp-tools 9.1.0.post12
File	Interpreter	ABI	Platform	Reset
dsp_tools-9.1.0.post12-py3-none-any.whl 274.3 kB Oct 7, 2024 Without provenance	Python 3	none	any	Details

Total release size: 8.6 MB

Release files / dsp_tools-9.1.0.post12.tar.gz

Download URL	dsp_tools-9.1.0.post12.tar.gz
Size	8.3 MB
Tags	Source
SHA-256 checksum How to use checksums	`20b82bc2390471c375baae2d72bb3e9ea8c9fb964ea5251e63f08432ed49fcc5`
BLAKE2b-256 checksum How to use checksums	`dd7cfde367a5dc9a1652b52a1a1726e5d318d536c86e1c15133efdf945304496`
Upload date	Oct 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.6`

Release files / dsp_tools-9.1.0.post12-py3-none-any.whl

Download URL	dsp_tools-9.1.0.post12-py3-none-any.whl
Size	274.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0a39d13049b0d9bc9bda98466a3343b2a65a70869aaaef14263c7bea379c6ff7`
BLAKE2b-256 checksum How to use checksums	`ccd141927408589b583b272b66424829e2d6abd551c5bde207a1ee5e1217aa5a`
Upload date	Oct 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.6`

Security for dsp-tools 9.1.0.post12

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.