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

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

Uploaded Source

Built Distribution

dsp_tools-1.1.5-py3-none-any.whl (105.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dsp-tools-1.1.5.tar.gz
  • Upload date:
  • Size: 98.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for dsp-tools-1.1.5.tar.gz
Algorithm Hash digest
SHA256 2fe6a99084fb70651224abe2458771561e830f980497db848c1919001f8da3f4
MD5 1c2ed6aaee3f1b0663f8ed51569a06b0
BLAKE2b-256 b216cd89b610bc2bc2f41d695c9fd336b0e90d5b798fb8d91dcf273a3bd808b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dsp_tools-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 105.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for dsp_tools-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cf8e4dcdd9906c2e5b1a8859aad25b4c39a669a25d6f3b6eb47ea190aab3c29e
MD5 10e473e22cc0aeceb610b2459379a661
BLAKE2b-256 c83f9a3d8cd1ed6109e0253fd54af79b5eab07508cb1b1c0c05df190898ca719

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