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.
  • 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.
  • 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-7.2.0.post18.tar.gz (175.0 kB view details)

Uploaded Source

Built Distribution

dsp_tools-7.2.0.post18-py3-none-any.whl (221.6 kB view details)

Uploaded Python 3

File details

Details for the file dsp_tools-7.2.0.post18.tar.gz.

File metadata

  • Download URL: dsp_tools-7.2.0.post18.tar.gz
  • Upload date:
  • Size: 175.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.5.0-1021-azure

File hashes

Hashes for dsp_tools-7.2.0.post18.tar.gz
Algorithm Hash digest
SHA256 36e9e09c7d3ab3ef627c4f89bca4a93bd9540c95e3c09dd68ad852baed25aed6
MD5 6e1a9ef2d95a47c8ea436bd8a32651b5
BLAKE2b-256 548a7a53d91022939dd519ef80c2d2d17235673273e642925d4698527293050f

See more details on using hashes here.

File details

Details for the file dsp_tools-7.2.0.post18-py3-none-any.whl.

File metadata

  • Download URL: dsp_tools-7.2.0.post18-py3-none-any.whl
  • Upload date:
  • Size: 221.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.5.0-1021-azure

File hashes

Hashes for dsp_tools-7.2.0.post18-py3-none-any.whl
Algorithm Hash digest
SHA256 9efaf451a8ae696d48666f03b44ded2e7997ee38d40072a7161e67e381361fcf
MD5 4970acb363129e53bee69948a79897f9
BLAKE2b-256 a8b25a23910b9ba583e81d2123530cf60f2f918051f2ee7be2ab57dab960020b

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