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
🚨 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 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 createcreates the project with its data model(s) on a DSP server from a JSON file.dsp-tools getreads a project with its data model(s) from a DSP server and writes it into a JSON file.dsp-tools validate-datavalidates an XML data file according to the ontology previously uploaded on the server.dsp-tools xmluploaduploads 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-filesuploads all files that are referenced in an XML file to a DSP server.dsp-tools ingest-fileskicks off the ingest process, and retrieves the mapping CSV when it is finished.dsp-tools ingest-xmluploadcreates the resources contained in the XML file, using the mapping CSV
dsp-tools resume-xmluploadresumes a previously interruptedxmluploadoringest-xmlupload.dsp-tools excel2jsoncreates an entire JSON project file from a folder with Excel files in it.dsp-tools excel2listscreates 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 withdsp-tools create.dsp-tools excel2resourcescreates 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 withdsp-tools create.dsp-tools excel2propertiescreates 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 withdsp-tools create.
dsp-tools old-excel2jsondoes the same as the newerexcel2jsoncommand, but the Excel format for thelistssection is different.dsp-tools old-excel2listsdoes the same as the newerexcel2listscommand, but the Excel format is different.
dsp-tools excel2xmltransforms a data source to XML if it is already structured according to the DSP specifications.- The module
excel2xmlprovides helper methods that can be used in a Python script to convert data from a tabular format into XML. (DEPRECATED in favor ofxmllib) - The
xmlliblibrary provides helper functions that can be used in a Python script to convert data from a tabular format into XML. dsp-tools id2iritakes 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-stackassist you in running a DSP stack on your local machine.dsp-tools templatecreates a template repository with a minimal JSON and XML file.dsp-tools rosettaclones the most up to date rosetta repository, creates the data model and uploads the data.
Release files for dsp-tools 13.0.0.post28
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| dsp_tools-13.0.0.post28.tar.gz | 7.3 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dsp_tools-13.0.0.post28-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.6 MB
Release files / dsp_tools-13.0.0.post28.tar.gz
| Download URL | dsp_tools-13.0.0.post28.tar.gz |
|---|---|
| Size | 7.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
016f8f440b2048abeb62f75da1cf34e832e68b5bbce4f7fb0f2e732cd7a16465
|
|
BLAKE2b-256 checksum How to use checksums |
16bf72477b687bef2d35faef9f442e27aa963b5847a84751fff3a14c3b399afa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
Release files / dsp_tools-13.0.0.post28-py3-none-any.whl
| Download URL | dsp_tools-13.0.0.post28-py3-none-any.whl |
|---|---|
| Size | 337.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25d20d940f63472cc4bf45ba6eaa07268386c7e0b168874e511f09767956b5ba
|
|
BLAKE2b-256 checksum How to use checksums |
088e213c497ad233183dd1e5e9b9d6d2329df1c8f0399480c1110829e2081fc6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
Security for dsp-tools 13.0.0.post28
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.
