DSP-TOOLS is a Python package with a command line interface that helps you interact with a DaSCH service platform (DSP) server.
Project description
DSP-TOOLS Documentation
Installing dsp-tools
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 dsp-tools package provides you with functionalities in the command line
to interact with the DSP-API, both remote and locally.
Additionally, it contains the xmllib which helps you construct the XML file required for a mass upload.
Where To Start?
dsp-tools provides you with the following core functionalities.
- Running a Local Stack: If you want to run your own DSP stack locally, take a look here.
- Data Modelling: There are several ways to create a data model with
dsp-tools- Take a look at the technical specification for the JSON file.
- Or take a look at our tool to convert Excel files into the JSON format.
- You can create a data model on the DSP-APP. To re-use that data model on another server you can use the CLI command described here.
- Data for Mass-Upload:
- If you want to create the XML file required for a mass-upload onto DSP, take a look at the
xmllib. - You can find an in-depth explanation of our XML file format here.
Please note, that we recommend to use the
xmlliblibrary to create the file as we will ensure interoperability between the DSP-API requirements and your input. - If you want to validate and upload your XML file take a look here. Please note, that only DaSCH employees are permitted to upload data on a production server.
- If you want to create the XML file required for a mass-upload onto DSP, take a look at the
List of CLI Commands
The following CLI Commands are available, listed here in alphabetical order.
| Command | Description | Documentation |
|---|---|---|
create |
Create a project on a server from a JSON filedsp-tools create project.json |
→ |
excel2json |
Create the project definition JSON from Excel filesdsp-tools excel2json excelfolder project.json |
→ |
excel2lists |
Create the list section of the project JSONdsp-tools excel2lists excelfolder lists.json |
→ |
excel2properties |
Create the properties section of the JSONdsp-tools excel2properties properties.xlsx properties.json |
→ |
excel2resources |
Create the resource section of the JSONdsp-tools excel2resources resources.xlsx resources.json |
→ |
get |
Retrieve a project definition JSON from a serverdsp-tools get -P 0XXX project.json |
→ |
id2iri |
Replace internal IDs with IRIs in an XML filedsp-tools id2iri new_data.xml id2iri_mapping.json |
→ |
ingest-files |
Kick off the ingest process and save the mapping CSVdsp-tools ingest-files 0XXX |
→ |
ingest-xmlupload |
Create resources from XML after files are ingesteddsp-tools ingest-xmlupload data.xml |
→ |
migration config |
Create a migration config YAML filedsp-tools migration config -P 0XXX |
→ |
migration complete |
Execute a complete migrationdsp-tools migration complete migration-0XXX.yaml |
→ |
migration export |
Download project data from the source serverdsp-tools migration export migration-0XXX.yaml |
→ |
migration import |
Import a downloaded export to another serverdsp-tools migration import migration-0XXX.yaml |
→ |
migration clean-up |
Clean up local files and server referencesdsp-tools migration clean-up migration-0XXX.yaml |
→ |
old-excel2json |
Create project definition JSON using the old Excel formatdsp-tools old-excel2json excelfolder project.json |
→ |
old-excel2lists |
Create the list section using the old Excel formatdsp-tools old-excel2lists excelfolder lists.json |
→ |
resume-xmlupload |
Resume a previously interrupted xmluploaddsp-tools resume-xmlupload |
→ |
start-stack |
Start a local DSP stackdsp-tools start-stack |
→ |
stop-stack |
Stop the local DSP stackdsp-tools stop-stack |
→ |
update-legal |
Update legal metadata in XML files to the new formatdsp-tools update-legal [mandatory options] data.xml |
→ |
upload-files |
Upload multimedia files referenced in an XML filedsp-tools upload-files data.xml |
→ |
validate-data |
Validate XML data against a data model on a serverdsp-tools validate-data data.xml |
→ |
xmlupload |
Create resources from an XML file on a serverdsp-tools xmlupload data.xml |
→ |
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-18.8.0.tar.gz
(325.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
dsp_tools-18.8.0-py3-none-any.whl
(461.8 kB
view details)
File details
Details for the file dsp_tools-18.8.0.tar.gz.
File metadata
- Download URL: dsp_tools-18.8.0.tar.gz
- Upload date:
- Size: 325.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8e4d4fd5b6662167d0c7b8a28fd8d5b70f227bbddf7180736d2e4154110c95d
|
|
| MD5 |
c44e723a231c703eef69eb5e502af24c
|
|
| BLAKE2b-256 |
4e84a25e730adaf0294e0d4f9eb554a04fa226629aa94af581b425be225d920c
|
File details
Details for the file dsp_tools-18.8.0-py3-none-any.whl.
File metadata
- Download URL: dsp_tools-18.8.0-py3-none-any.whl
- Upload date:
- Size: 461.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98785a22c6a33d45452a54a33083fd1c06526c6c95f82757e220092288b3166a
|
|
| MD5 |
457106f7723fc5ee17a2fa92eeee4c85
|
|
| BLAKE2b-256 |
86c41c0fdb7dccc573b235481284002d43d3e7d2adf16a6ce057142e8b1ebf92
|
