Metadata-Version: 2.4
Name: dovecli
Version: 0.1.2
Summary: Command-line client for the Dovetail Analysis Portal (DAP): authenticate, list, and submit a run, download, and upload files.
Author-email: Ekkachai Danwanichakul <edanwanichakul@dovetail-genomics.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: click>=8.1
Requires-Dist: requests>=2.31

# DAP CLI

`dap` is the command-line client for the Dovetail Analysis Portal (DAP):
log in, list and submit runs, and upload/download files without leaving a
terminal. It talks to the DAP server over plain HTTP and is a standalone
package, separate from the DAP web app itself.

## Install

```console
$ pip install dovecli
```

This installs the `dap` command on your `PATH`, along with its only two
runtime dependencies, [click](https://click.palletsprojects.com/) and
[requests](https://requests.readthedocs.io/). Requires Python 3.9+.

## Quickstart

```console
$ dap login
Email: you@example.com
Password:
Logged in.

$ dap whoami
you@example.com -- 5 credits

$ dap files list
$ dap files upload /path/to/reads_R1.fastq.gz

$ dap runs cancer-types
$ dap submit sv --name my-first-run \
    --tumor s3://bucket/user_1/tumor_R1.fastq.gz s3://bucket/user_1/tumor_R2.fastq.gz \
    --cancer-type Breast

$ dap runs list
$ dap runs status <run-id> --watch
```

By default `dap` talks to `https://portal.cantatabio.com`. Point it at a
different server with `dap login --api-url ...` or the `DAP_API_URL`
environment variable. Your login token is stored locally at
`~/.dap/config.json` (override with `DAP_CONFIG_DIR`); your password is
never saved.
