Skip to main content

CLI tool for iFlow - genomic data management and workflow execution

Project description

intelliseq-iflow

CLI tool for iFlow - genomic data management and workflow execution.

Installation

pip install intelliseq-iflow

Usage

Authentication

Login using OAuth Device Flow:

iflow login

This will open a browser for authentication. Your credentials are stored securely in your system keyring.

Check login status:

iflow status

Logout:

iflow logout

File Operations

List files in a project:

iflow files ls --project PROJECT_ID
iflow files ls --project PROJECT_ID --path data/raw/

Download a file:

iflow files download --project PROJECT_ID --path data/file.txt
iflow files download --project PROJECT_ID --path data/file.txt -o local_file.txt

Upload a file:

iflow files upload --project PROJECT_ID local_file.txt data/uploaded.txt

Running Pipelines

Submit a pipeline run:

iflow runs submit --pipeline hereditary-mock \
  -P case_id=patient-001 \
  -P child_fastq=data/R1.fastq.gz \
  --watch

With LIS callback:

iflow runs submit --pipeline hereditary-panel \
  -P vcf_file=data/sample.vcf.gz \
  --callback-url https://lis.example.com/api/callback

Configuration

Configure environment:

iflow config env dev    # Development
iflow config env stg    # Staging
iflow config env prod   # Production

Select default project:

iflow config select-project

View current configuration:

iflow config show

Development

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Format code
ruff format .
ruff check --fix .

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

intelliseq_iflow-0.3.4.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intelliseq_iflow-0.3.4-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

Details for the file intelliseq_iflow-0.3.4.tar.gz.

File metadata

  • Download URL: intelliseq_iflow-0.3.4.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for intelliseq_iflow-0.3.4.tar.gz
Algorithm Hash digest
SHA256 8a35582da42ef7332a6f35679632187f12f22dd5eb9583d0e39e161a3a1a23eb
MD5 9311321ec57fce170f67be1f2f79500a
BLAKE2b-256 5e1b3d5f6539112eeb3f0426a91fc4ac1fff3f1272f0bec5df60a0c54135839b

See more details on using hashes here.

File details

Details for the file intelliseq_iflow-0.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for intelliseq_iflow-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0c053952ed24c7cb614492d052a696810130196c11533e549240f70306878bc1
MD5 ea98c301a1879f9abf1bf2e67f5f49db
BLAKE2b-256 012cc5c56917a0d26afa267f7cf7181813b2a240465082e7f2c50dd7d07ab814

See more details on using hashes here.

Supported by

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