<p>
<h1 align="center">Data Delivery System: CLI</h1>
</p>
<p align="center">
<b>A command line tool `dds` to manage projects and data in the SciLifeLab Data Delivery System.</b>
</p>
<br />
<p align="center">
<img alt="Release" src="https://img.shields.io/github/v/release/SciLifeLabDataCentre/dds_cli">
<a href="https://pypi.org/project/dds-cli/">
<img alt="Install from PyPi" src="https://img.shields.io/badge/install%20with-PyPI-blue.svg?logo=pypi">
</a>
<a href="https://opensource.org/licenses/MIT">
<img alt="Licence: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg">
</a>
<a href="[https://opensource.org/licenses/MIT](https://github.com/psf/black)">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://prettier.io/">
<img alt="Code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
</a>
<br />
<a href="https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/lint-black-cli.yml">
<img alt="codecov" src="https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/lint-black-cli.yml/badge.svg?event=push">
</a>
<img alt="CodeQL" src="https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/codeql-cli.yml/badge.svg">
<a href="https://codecov.io/gh/ScilifelabDataCentre/dds_web">
<img alt="codecov" src="https://codecov.io/gh/ScilifelabDataCentre/dds_cli/branch/dev/graph/badge.svg?token=r5tM6o08Sd">
</a>
<img alt="Tests" src="https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/pytest-cli.yml/badge.svg">
</p>
<p align="center">
<b>Links</b>
<br />
<a href="https://scilifelabdatacentre.github.io/dds_cli/">
<img alt="Documentation" src="https://img.shields.io/badge/-Documentation-222222?logo=github-pages">
</a>
<a href="https://github.com/ScilifelabDataCentre/dds_web/blob/master/doc/Technical-Overview.pdf">
<img alt="Technical Overview" src="https://img.shields.io/badge/-Technical%20Overview-informational?logo=github">
</a>
<a href="https://github.com/ScilifelabDataCentre/dds_web/wiki/Architecture-Decision-Record,-ADR">
<img alt="Architecture Decision Record" src="https://img.shields.io/badge/-ADR-000000?logo=github">
</a>
<a href="https://github.com/ScilifelabDataCentre/dds_web/blob/master/doc/Troubleshooting.pdf">
<img alt="Troubleshooting" src="https://img.shields.io/badge/-Troubleshooting%20Guide-red?logo=github">
</a>
<a href="https://github.com/ScilifelabDataCentre/dds_web">
<img alt="CLI" src="https://img.shields.io/badge/-Web / API-yellow?logo=github">
</a>
</p>
## 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:
### 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 .
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ScilifelabDataCentre/dds_cli",
"name": "dds-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "SciLifeLab Data Centre",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/64/e6/9a27896a2516dc01976518b282c8e1aed0cf5b8b82f9cee69e5fa6c53d01/dds_cli-2.6.4.tar.gz",
"platform": null,
"description": "<p>\n <h1 align=\"center\">Data Delivery System: CLI</h1>\n</p>\n\n<p align=\"center\">\n <b>A command line tool `dds` to manage projects and data in the SciLifeLab Data Delivery System.</b>\n</p>\n<br />\n\n<p align=\"center\">\n<img alt=\"Release\" src=\"https://img.shields.io/github/v/release/SciLifeLabDataCentre/dds_cli\">\n<a href=\"https://pypi.org/project/dds-cli/\">\n <img alt=\"Install from PyPi\" src=\"https://img.shields.io/badge/install%20with-PyPI-blue.svg?logo=pypi\">\n</a>\n<a href=\"https://opensource.org/licenses/MIT\">\n <img alt=\"Licence: MIT\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\">\n</a>\n<a href=\"[https://opensource.org/licenses/MIT](https://github.com/psf/black)\">\n <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n</a>\n<a href=\"https://prettier.io/\">\n <img alt=\"Code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\">\n</a>\n<br />\n<a href=\"https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/lint-black-cli.yml\">\n <img alt=\"codecov\" src=\"https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/lint-black-cli.yml/badge.svg?event=push\">\n</a>\n<img alt=\"CodeQL\" src=\"https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/codeql-cli.yml/badge.svg\">\n<a href=\"https://codecov.io/gh/ScilifelabDataCentre/dds_web\">\n <img alt=\"codecov\" src=\"https://codecov.io/gh/ScilifelabDataCentre/dds_cli/branch/dev/graph/badge.svg?token=r5tM6o08Sd\">\n</a>\n<img alt=\"Tests\" src=\"https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/pytest-cli.yml/badge.svg\">\n</p>\n\n<p align=\"center\">\n<b>Links</b>\n<br />\n<a href=\"https://scilifelabdatacentre.github.io/dds_cli/\">\n <img alt=\"Documentation\" src=\"https://img.shields.io/badge/-Documentation-222222?logo=github-pages\">\n</a>\n<a href=\"https://github.com/ScilifelabDataCentre/dds_web/blob/master/doc/Technical-Overview.pdf\">\n <img alt=\"Technical Overview\" src=\"https://img.shields.io/badge/-Technical%20Overview-informational?logo=github\">\n</a>\n<a href=\"https://github.com/ScilifelabDataCentre/dds_web/wiki/Architecture-Decision-Record,-ADR\">\n <img alt=\"Architecture Decision Record\" src=\"https://img.shields.io/badge/-ADR-000000?logo=github\">\n</a>\n<a href=\"https://github.com/ScilifelabDataCentre/dds_web/blob/master/doc/Troubleshooting.pdf\">\n <img alt=\"Troubleshooting\" src=\"https://img.shields.io/badge/-Troubleshooting%20Guide-red?logo=github\">\n</a>\n<a href=\"https://github.com/ScilifelabDataCentre/dds_web\">\n <img alt=\"CLI\" src=\"https://img.shields.io/badge/-Web / API-yellow?logo=github\">\n</a>\n</p>\n\n## About\n\n**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.**\n\n> _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._\n\n---\n\n## Table of contents\n\n- [Installation](#installation)\n- [Overview of commands](#overview-of-commands)\n\n## Installation\n\n### Python Package Index\n\nThe `dds-cli` package can be installed from [PyPI](https://pypi.python.org/pypi/dds_cli/) using pip as follows:\n\n```bash\npip install --upgrade dds-cli\n```\n\nAfter installing, run `dds` (or `dds --help`) and verify that the output looks like this:\n\n\n\n### Executables\n\nExecutables 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/)\n\n### Development version\n\nIf you would like the latest development version of tools, the command is:\n\n```bash\npip install --upgrade --force-reinstall git+https://github.com/ScilifelabDataCentre/dds_cli.git@dev\n```\n\nIf you intend to make edits to the code, first make a fork of the repository and then clone it locally.\nGo to the cloned directory and install with pip (also installs development requirements):\n\n```bash\npip install --upgrade -r requirements-dev.txt -e .\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command line tool to manage data and projects in the SciLifeLab Data Delivery System.",
"version": "2.6.4",
"project_urls": {
"Homepage": "https://github.com/ScilifelabDataCentre/dds_cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05b4f876f7a0b1ff138deaba700bfcb921ee2d98207f733cc99d2d330bc01c61",
"md5": "341971be9fd1ede5ca1ad5c76739e103",
"sha256": "fa229bfd72b58f14f194914782203e7109cc63844efcda5b186212c311a4bbb0"
},
"downloads": -1,
"filename": "dds_cli-2.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "341971be9fd1ede5ca1ad5c76739e103",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 100644,
"upload_time": "2024-04-09T14:34:52",
"upload_time_iso_8601": "2024-04-09T14:34:52.224626Z",
"url": "https://files.pythonhosted.org/packages/05/b4/f876f7a0b1ff138deaba700bfcb921ee2d98207f733cc99d2d330bc01c61/dds_cli-2.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64e69a27896a2516dc01976518b282c8e1aed0cf5b8b82f9cee69e5fa6c53d01",
"md5": "2ec20630613e648cfb9205a1e5eb9239",
"sha256": "8cb62eda4f29adcf130601ddd9f00b57aee76e5f73fa7653e210b9827f58d5b9"
},
"downloads": -1,
"filename": "dds_cli-2.6.4.tar.gz",
"has_sig": false,
"md5_digest": "2ec20630613e648cfb9205a1e5eb9239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 81485,
"upload_time": "2024-04-09T14:34:53",
"upload_time_iso_8601": "2024-04-09T14:34:53.720726Z",
"url": "https://files.pythonhosted.org/packages/64/e6/9a27896a2516dc01976518b282c8e1aed0cf5b8b82f9cee69e5fa6c53d01/dds_cli-2.6.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 14:34:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ScilifelabDataCentre",
"github_project": "dds_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dds-cli"
}
JSON
