Metadata-Version: 2.4
Name: vcp-cli
Version: 0.50.0
Summary: VCP CLI - A command-line interface (CLI) to the Chan Zuckerberg Initiative's Virtual Cell Platform (VCP)
Author-email: Chan Zuckerberg Initiative <info@chanzuckerberg.com>
License: MIT
Requires-Python: <3.14,>=3.10
Requires-Dist: authlib>=1.0.0
Requires-Dist: boto3>=1.34.0
Requires-Dist: click>=8.0.0
Requires-Dist: cryptography>=41.0.0
Requires-Dist: packaging>=20.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pyjwt>=2.8.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: requests>=2.0.0
Requires-Dist: rich>=10.0.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: tqdm==4.67.1
Requires-Dist: werkzeug>=2.0.0
Provides-Extra: all
Requires-Dist: anndata>=0.9.0; extra == 'all'
Requires-Dist: copier>=9.9.0; extra == 'all'
Requires-Dist: cz-benchmarks~=0.14.0; extra == 'all'
Requires-Dist: gitpython>=3.1.0; extra == 'all'
Requires-Dist: mlflow>=2.0.0; extra == 'all'
Requires-Dist: mypy-boto3-s3>=1.39.2; extra == 'all'
Requires-Dist: numpy>=1.25; extra == 'all'
Provides-Extra: benchmarks
Requires-Dist: anndata>=0.9.0; extra == 'benchmarks'
Requires-Dist: cz-benchmarks~=0.14.0; extra == 'benchmarks'
Provides-Extra: data
Requires-Dist: mypy-boto3-s3>=1.39.2; extra == 'data'
Provides-Extra: model
Requires-Dist: copier>=9.9.0; extra == 'model'
Requires-Dist: gitpython>=3.1.0; extra == 'model'
Requires-Dist: mlflow>=2.0.0; extra == 'model'
Requires-Dist: numpy>=1.25; extra == 'model'
Description-Content-Type: text/markdown

# Virtual Cells Platform Command Line Interface

[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://github.com/chanzuckerberg/vcp-cli/actions)
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)

A command-line interface for interacting with the Virtual Cells Platform ("VCP").

## Requirements

- [Python 3.10+](https://www.python.org/downloads/)
- On MacOS or [Windows WSL](https://learn.microsoft.com/en-us/windows/wsl/), you will need a terminal app.
- For the `benchmarks` commands, you will need to be running on an Intel/AMD64 architecture CPU with NVIDIA GPU, running Linux with NVIDIA drivers.
- For other commands (e.g. `data`) you will need a Virtual Cells Platform account ([register here](https://virtualcellmodels.cziscience.com/?register=true))


## Installation

### Core Installation (Minimal)

Install only the core CLI functionality (auth, config, version commands):

```bash
pip install vcp-cli
```

This installs a minimal footprint without heavy dependencies like MLflow or benchmarking tools.

### Full Installation

Install all features (model, data, and benchmarks commands):

```bash
pip install 'vcp-cli[all]'
```

### Selective Installation

Install only the features you need:

```bash
# For model operations only
pip install 'vcp-cli[model]'

# For data operations only
pip install 'vcp-cli[data]'

# For benchmarks only
pip install 'vcp-cli[benchmarks]'

# Combine multiple features
pip install 'vcp-cli[model,data]'
```

**Optional Feature Groups:**
- `model` - Model operations (init, stage, submit)
- `data` - Data operations (search, download, describe)
- `benchmarks` - Benchmark operations (run, list, get)

## Documentation

Available at https://chanzuckerberg.github.io/vcp-cli/


## License

This package is licensed under the MIT License.