docs: add README

This commit is contained in:
yunpeng.zhang 2026-01-16 14:54:24 +08:00
parent 0ebb84a8d1
commit e0b4037a59
2 changed files with 22 additions and 0 deletions

17
README.md Normal file
View File

@ -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
```

5
tests/test_readme.py Normal file
View File

@ -0,0 +1,5 @@
from pathlib import Path
def test_readme_present():
assert Path("README.md").exists()