Skip to main content

A Python library and tools for the DaSCH Service Platform

Project description

PyPI version

DSP-TOOLS - DaSCH Service Platform Tools

dsp-tools is a command line tool that helps you interact with the DaSCH Service Platform server (DSP server).

Go to Full Documentation

Information for developers

There is a Makefile for all the following tasks (and more). Type make to print the available targets.

Install from source

To install from source run:

python3 setup.py install

Install the requirements

To install the requirements run:

pip3 install -r requirements.txt

To generate a requirements file (usually requirements.txt), that you commit with your project, run:

pip3 freeze > requirements.txt

Testing

Please note that testing requires launching the complete DSP API stack which is based on docker images. Therefore, we recommend installing the docker desktop client.

To run the complete test suite:

make test

Publishing

Publishing is automated with GitHub Actions and should not be done manually. Please follow the Pull Request Guidelines. If done correctly, when merging a pull request into main, the release-please action will create or update a pull request for a release. This pull request will follow semantic versioning and update the change log. Once all desired features are merged, the release can be executed by merging this release pull request into main. This will trigger actions that create a release on GitHub, on PyPI and the docs.

Please ensure you have only one pull request per feature.

Publishing manually

Publishing is automated with GitHub Actions and should not be done manually. If you still need to do it, follow the steps below.

Generate the distribution package. Make sure you have the latest versions of setuptools and wheel installed:

python3 -m pip install --upgrade pip setuptools wheel
python3 setup.py sdist bdist_wheel

You can install the package locally from the dist:

python3 -m pip ./dist/some_name.whl

Upload package works also with make:

make dist
make upload

For local development:

python3 setup.py develop

Contributing to the documentation

The documentation is a collection of markdown files in the docs folder.
After updates of the files, build and check the result with the following commands:

make build-docs
make serve-docs 

To update the changes to the official documentation pages run:

make publish-docs

Project details


Release history Release notifications | RSS feed

This version

1.3.3

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

Uploaded Source

Built Distribution

dsp_tools-1.3.3-py3-none-any.whl (111.2 kB view details)

Uploaded Python 3

File details

Details for the file dsp-tools-1.3.3.tar.gz.

File metadata

  • Download URL: dsp-tools-1.3.3.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for dsp-tools-1.3.3.tar.gz
Algorithm Hash digest
SHA256 2e03215172da548ba4674f2eb693b01f2f19a075ce3112be1f3f3f6ab7733501
MD5 ee32a9b2d159eddcac1cd1e500238044
BLAKE2b-256 8be02a7c0a1b561477855d8421cb545a2c40d25a10a498d6e256c85e9ea80ffb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dsp_tools-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 111.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for dsp_tools-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 26b9e45b0f1c8d859b54b2ebebb4b1a020d11b35c14930fc68a1ecd85706138e
MD5 ab2f469c9e023e0c1dc247e94a62059e
BLAKE2b-256 c3526e67e853dd9db16480b8ae993730268215f05fd6b59be95ec52b3003adeb

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