Metadata-Version: 2.1
Name: dds-cli
Version: 0.0.5
Summary: A command line tool to manage data and projects in the SciLifeLab Data Delivery System.
Home-page: https://github.com/ScilifelabDataCentre/dds_cli
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs (==21.4.0)
Requires-Dist: boto3 (==1.21.8)
Requires-Dist: botocore (==1.24.8)
Requires-Dist: certifi (==2021.10.8)
Requires-Dist: cffi (==1.15.0)
Requires-Dist: charset-normalizer (==2.0.12)
Requires-Dist: click (==8.0.4)
Requires-Dist: click-pathlib (==2020.3.13.0)
Requires-Dist: colorama (==0.4.4)
Requires-Dist: commonmark (==0.9.1)
Requires-Dist: cryptography (==36.0.1)
Requires-Dist: Deprecated (==1.2.13)
Requires-Dist: idna (==3.3)
Requires-Dist: immutabledict (==2.2.1)
Requires-Dist: iniconfig (==1.1.1)
Requires-Dist: jmespath (==0.10.0)
Requires-Dist: jwcrypto (==1.0)
Requires-Dist: numpy (==1.22.2)
Requires-Dist: packaging (==21.3)
Requires-Dist: pandas (==1.4.1)
Requires-Dist: pluggy (==1.0.0)
Requires-Dist: prettytable (==3.1.1)
Requires-Dist: prompt-toolkit (==3.0.28)
Requires-Dist: py (==1.11.0)
Requires-Dist: pycparser (==2.21)
Requires-Dist: Pygments (==2.11.2)
Requires-Dist: PyNaCl (==1.5.0)
Requires-Dist: pyparsing (==3.0.7)
Requires-Dist: pytest (==7.0.1)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: pytz (==2021.3)
Requires-Dist: pytz-deprecation-shim (==0.1.0.post0)
Requires-Dist: PyYAML (==6.0)
Requires-Dist: questionary (==1.10.0)
Requires-Dist: requests (==2.27.1)
Requires-Dist: rich (==11.2.0)
Requires-Dist: rich-click (==1.0.0)
Requires-Dist: s3transfer (==0.5.2)
Requires-Dist: simplejson (==3.17.6)
Requires-Dist: six (==1.16.0)
Requires-Dist: tomli (==2.0.1)
Requires-Dist: tzdata (==2021.5)
Requires-Dist: tzlocal (==4.1)
Requires-Dist: urllib3 (==1.26.8)
Requires-Dist: wcwidth (==0.2.5)
Requires-Dist: wrapt (==1.13.3)
Requires-Dist: zstandard (==0.17.0)

# SciLifeLab Data Delivery System - Command line interface

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![install with PyPI](https://img.shields.io/badge/install%20with-PyPI-blue.svg)](https://pypi.org/project/dds_cli/)

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

This will be used for data delivery within larger projects and/or projects resulting in the production of large amounts of data, for example next-generation sequencing data and imaging.

This tool is written and maintained by the [SciLifeLab Data Centre](https://www.scilifelab.se/data).

## Table of contents

* [Installation](#installation)
* [Overview of commands](#overview-of-commands)

## Installation

### Python Package Index

> :warning: Only pre-releases so far.

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

```bash
pip install dds-cli
```

### 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 .
```

## Overview of commands

Once installed you can use the command `dds` in a terminal session. This has the following subcommands:

* `get` - Download specified files from the cloud and restore the original format.
* `ls` - List the projects and the files within projects.
* `put` - Process and upload specified files to the cloud.
* `rm` - Delete files within a project.


