vcp-cli 0.45.0rc1

VCP CLI - A command-line interface (CLI) to the Chan Zuckerberg Initiative's Virtual Cell Platform (VCP)

Virtual Cells Platform Command Line Interface

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

Requirements

• 🐍 Python 3.10+: Ensure you have Python 3.10 or later installed.

Installation

pip install vcp-cli

Usage

Login

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

vcp login --username [e-mail]

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:

   make setup
   

2. Run tests:

   make test
   

3. Run E2E tests:

   APP_ENV=staging uv run pytest tests/e2e  # Run against staging environment
   APP_ENV=prod uv run pytest tests/e2e     # Run against prod environment
   

   Note: E2E tests require environment-specific configuration files (.env.staging or .env.prod) in the tests/e2e/ directory.

4. Other development commands:

   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:

   uv sync --group docs
   

2. Build the documentation:

   cd docs
   uv run make html
   

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

License

[Add your license information here]