From e0b4037a592e8e671a2a9da1462cf388a234f7c6 Mon Sep 17 00:00:00 2001 From: "yunpeng.zhang" Date: Fri, 16 Jan 2026 14:54:24 +0800 Subject: [PATCH] docs: add README --- README.md | 17 +++++++++++++++++ tests/test_readme.py | 5 +++++ 2 files changed, 22 insertions(+) create mode 100644 README.md create mode 100644 tests/test_readme.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e41dc6 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# TCGA Downloader + +Python package + CLI to query public TCGA files and download via gdc-client. + +## Install + +```bash +pip install -e . +``` + +## Example + +```bash +tcga-downloader query --project TCGA-BRCA --data-type "Gene Expression" --out manifest.tsv + +tcga-downloader download --manifest manifest.tsv --out-dir ./data +``` diff --git a/tests/test_readme.py b/tests/test_readme.py new file mode 100644 index 0000000..72e1935 --- /dev/null +++ b/tests/test_readme.py @@ -0,0 +1,5 @@ +from pathlib import Path + + +def test_readme_present(): + assert Path("README.md").exists()