A command line tool to manage data and projects in the SciLifeLab Data Delivery System.
Project description
SciLifeLab Data Delivery System - Command line interface
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.
Table of contents
Installation
Python Package Index
:warning: Only pre-releases so far.
The dds-cli
package can be installed from PyPI using pip as follows:
pip install dds-cli
After installing, run dds
and verify that the output looks like this:
$ dds
︵
︵ ( ) ︵
( ) ) ( ( ) SciLifeLab Data Delivery System
︶ ( ) ) ( https://delivery.scilifelab.se/
︶ ( ) Version 0.0.6
︶
Current user: dds_admin
Usage: dds [OPTIONS] COMMAND [ARGS]...
SciLifeLab Data Delivery System (DDS) command line interface.
Access token is saved in a .dds_cli_token file in the home directory.
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --verbose -v Print verbose output to the console. │
│ --log-file -l <filename> Save a log to a file. │
│ --no-prompt Run without any interactive features. │
│ --version Show the version and exit. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ auth Group command for creating and managing authenticated sessions. │
│ data Group command for uploading, downloading and managing project data. │
│ ls List the projects you have access to or the project contents. │
│ project Group command for creating and managing projects within the DDS. │
│ user Group command for managing user accounts, including your own. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
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 .
Overview of commands
Once installed you can use the command dds
in a terminal session. This has the following subcommands:
auth
: Create and manage authenticated sessions.user
: Create and manage user accounts, including your own.project
: Create and manage projects.data
: Upload, download and manage project data.ls
: List projects and project contents.
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
Built Distribution
Hashes for dds_cli-0.0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b1e2d813c15b4bf1773b5e6fd1a343b5346f5cb87101bdca6df1984c2d89965 |
|
MD5 | a4f8ed217500512d8db5dadca744aff1 |
|
BLAKE2b-256 | 57aaa2acfa65bdd5d35258445b35905402802667acf84d861f27440028756773 |