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.3.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.3-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: intelliseq_iflow-0.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 63708ca7733a2eb4a8672596fcc7566a3fda6566d0bcc4d46f18331eb60e0efb
MD5 7f7d38015a4c9a2112cd8408cfb0ab04
BLAKE2b-256 16adf0a9b5a29ca925deebf9703fa19094d7d890e24137f8cbf4901e3113f002

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for intelliseq_iflow-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ceba07264cb6330e4abb7862eecff3581f9aae41e5c9836a9cf526468773e938
MD5 0ff8c60c7a643c1aa921ad7512557ba4
BLAKE2b-256 eb0f7984cee037f5b93148792a74bf867a1e7fb56cca33a1d10e2b2cdfe7c98e

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