Metadata-Version: 2.4
Name: vcp-cli
Version: 0.43.0rc11
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.10
Requires-Dist: anndata>=0.9.0
Requires-Dist: authlib>=1.0.0
Requires-Dist: boto3>=1.34.0
Requires-Dist: click>=8.0.0
Requires-Dist: copier>=9.9.0
Requires-Dist: cryptography>=41.0.0
Requires-Dist: cz-benchmarks>=0.11.2
Requires-Dist: gitpython>=3.1.0
Requires-Dist: mlflow>=2.0.0
Requires-Dist: numpy>=1.25
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
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 Cell Platform ("VCP").

## Requirements

- 🐍 **[Python 3.10+](https://www.python.org/downloads/)**: Ensure you have Python 3.10 or later installed.


## Installation

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

## Usage

### Login

To log in to the VCP platform, use the following command:

```bash
vcp login --username your.email@example.com
```

This command will prompt you to enter your password securely.

### Model Commands

The following commands are available for model management:

- **List Models**: `vcp model list`
- **Download Model**: `vcp model download`
- **Submit Model**: `vcp model submit <yaml_file>` - Submit model data to the VCP Model Hub API

### Data Commands

The following commands are available for data:

- #### Search for Data:
   Allows you to search MDR for authorized datasets by TERM.
   **Command:** `vcp data search <TERM>`
   **Example:** `vcp data search "cryoet"`

- #### Get information about a Dataset:
   Get a summary table with information about id, domain, label, doi, cell_count, species, tissues, and asset location
   **Command:** `vcp data describe <DATASET_ID>`

- #### Download a Dataset:
   Download a specific dataset by id.
   **Command:** `vcp data download [OPTIONS] DATASET_ID`

### Other Commands

Additional commands will be documented here as they are implemented.

## Development

1. Install development dependencies:
   ```bash
   make setup
   ```

2. Run tests:
   ```bash
   make test
   ```

3. Other development commands:
   ```bash
   make lint      # Run linting checks
   make format    # Format code
   make build     # Build the package
   make dev       # Run in development mode
   ```

## Documentation

1. Install docs dependencies:
   ```bash
   uv sync --group docs
   ```

2. Build the documentation:
   ```bash
   cd docs
   uv run make html
   ```

The built artifacts will be in `docs/_build/html`.

## License

[Add your license information here]
