/dds_cli

The command line interface for access to the Data Delivery System primarily developed by the SciLifeLab Data Centre.

Primary LanguagePythonMIT LicenseMIT

Data Delivery System: CLI

A command line tool `dds` to manage projects and data in the SciLifeLab Data Delivery System.


Release Install from PyPi Licence: MIT Code style: black Code style: prettier
codecov CodeQL codecov Tests

Links
Documentation Technical Overview Architecture Decision Record Troubleshooting CLI

About

The Data Delivery System (DDS) is a cloud-based system for all SciLifeLab platforms where data generated throughout each project can be delivered to the research groups in a fast, secure and simple way. The CLI makes requests to the API (see badge below for link) in order to use the API functionality.

The Data Delivery System is developed and maintained by the SciLifeLab Data Centre. National Genomics Infrastructure (NGI) Stockholm has been a part of the development team during 2021 and early 2022.

Table of contents

Installation

Python Package Index

The dds-cli package can be installed from PyPI using pip as follows:

pip install --upgrade dds-cli

After installing, run dds (or dds --help) and verify that the output looks like this:

dds help command

Executables

Executables are available for Windows, MacOS and Linux. These allow you to run the CLI without needing to install it (and the pip / Python requirements) yourself. Download them from the (bottom of the) latest release page: Latest Release

Development version

If you would like the latest development version of tools, the command is:

pip install --upgrade --force-reinstall git+https://github.com/ScilifelabDataCentre/dds_cli.git@dev

If you intend to make edits to the code, first make a fork of the repository and then clone it locally. Go to the cloned directory and install with pip (also installs development requirements):

pip install --upgrade -r requirements-dev.txt -e .