https://github.com/scilifelabdatacentre/dds_cli

The command line interface for access to the Data Delivery System primarily developed by the SciLifeLab Data Centre.
https://github.com/scilifelabdatacentre/dds_cli

click command-line python

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/scilifelabdatacentre/dds_cli
• Owner: ScilifelabDataCentre
• License: mit
• Created: 2019-09-26T12:45:35.000Z (over 5 years ago)
• Default Branch: dev
• Last Pushed: 2024-04-09T14:33:42.000Z (about 1 year ago)
• Last Synced: 2024-05-09T10:45:48.809Z (12 months ago)
• Topics: click, command-line, python
• Language: Python
• Homepage:
• Size: 101 MB
• Stars: 7
• Watchers: 5
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


   
Data Delivery System: CLI




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












    





    





    





    








    





 

  

 







Links






    





    





    





    





    





## 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](#installation)

- [Overview of commands](#overview-of-commands)

## Installation

### Python Package Index

The `dds-cli` package can be installed from [PyPI](https://pypi.python.org/pypi/dds_cli/) using pip as follows:

```bash

pip install --upgrade dds-cli

```

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

![dds help command](img/dds-help-1.svg)

### 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](https://github.com/ScilifelabDataCentre/dds_cli/releases/latest/)

### Development version

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

```bash

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):

```bash

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

```