Skip to main content

CLI tool and SDK for interacting with the Cirro platform

Project description

Cirro Client

Build Python package Lint and run tests Quality Gate Status

A Python 3.9+ library for the Cirro platform.


You can install Cirro using pip:

pip install cirro

or you can install the main branch of the repo by running:

pip install git+


Upon first use, the Cirro client will ask if you would like to save your login information and give you a link to authenticate through the web browser.

If you need to change your credentials after this point, and you've opted to save your login, please see the clearing saved login section.

Command Line Usage

Downloading a dataset:

Usage: cirro download [OPTIONS]

  Download dataset files

  --project TEXT         Name or ID of the project
  --dataset TEXT         ID of the dataset
  --data-directory TEXT  Directory to store the files
  -i, --interactive      Gather arguments interactively
  --help                 Show this message and exit.

Uploading a dataset:

Usage: cirro upload [OPTIONS]

  Upload and create a dataset

  --name TEXT             Name of the dataset
  --description TEXT      Description of the dataset (optional)
  --project TEXT          Name or ID of the project
  --process TEXT          Name or ID of the ingest process
  --data-directory TEXT   Directory you wish to upload
  -i, --interactive       Gather arguments interactively
  --help                  Show this message and exit.

Listing datasets:

Usage: cirro list-datasets [OPTIONS]

  List available datasets

  --project TEXT         ID of the project
  -i, --interactive      Gather arguments interactively
  --help                 Show this message and exit.

Interactive Commands

When running a command, you can specify the --interactive flag to gather the command arguments interactively.


$ cirro upload --interactive
? What project is this dataset associated with?  Test project
? Enter the full path of the data directory  /shared/biodata/test
? Please confirm that you wish to upload 20 files (0.630 GB)  Yes
? What type of files?  Illumina Sequencing Run
? What is the name of this dataset?  test
? Enter a description of the dataset (optional)

Python Usage

See the following set of Jupyter notebooks that contain examples on the following topics:

Jupyter Notebook Topic
Introduction Installing and authenticating
Uploading a dataset Uploading data
Downloading a dataset Downloading data
Interacting with a dataset Calling data and reading into tables
Analyzing a dataset Running analysis pipelines
Using references Managing reference data
Advanced usage Advanced operations

R Usage

Jupyter Notebook Topic
Downloading a dataset in R Reading data with R

Advanced Usage

View the API documentation for this library here.

Supported environment variables

Name Description Default
CIRRO_HOME Local configuration directory ~/.cirro
CIRRO_BASE_URL Base URL of the data portal


The cirro configure command creates a file in CIRRO_HOME called config.ini.

You can set the base_url property in the config file rather than using the environment variable.

The transfer_max_retries configuration property specifies the maximum number of times to attempt uploading a file to Cirro in the event of a transfer failure. When uploading files to Cirro, network issues or temporary outages can occasionally cause a transfer to fail. It will pause for an increasing amount of time for each retry attempt.

The enable_additional_checksums property manages the utilization of SHA-256 hashing for enhanced data integrity. This feature computes the SHA-256 hash of a file during the upload process, and subsequently cross-validates it with the server upon completion. When retrieving files, it ensures that the hash received matches the server's stored hash. The default hashing algorithm for files is MD5. In many cases, MD5 is sufficient to ensure data integrity upon upload.

base_url =
transfer_max_retries = 15
enable_additional_checksums = true

Clearing saved login

You can clear your saved login information by removing the ~/.cirro/token.dat file from your system or by running cirro configure and selecting No when it asks if you'd like to save your login information.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cirro-1.0.1.tar.gz (39.1 kB view hashes)

Uploaded Source

Built Distribution

cirro-1.0.1-py3-none-any.whl (55.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page