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.1.tar.gz (35.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.1-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: intelliseq_iflow-0.3.1.tar.gz
  • Upload date:
  • Size: 35.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.1.tar.gz
Algorithm Hash digest
SHA256 86f89b8a95de5b5cc399eb08ca7aa7397fd669986ab975c1613395ae3e02ce91
MD5 e4b62434aec2eecfc1486eb0251c8011
BLAKE2b-256 8081acd4c056ac068ee3d0c4ddd87f58a1bae56e4c2f511842ce34b8b909a772

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for intelliseq_iflow-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 589f23724afb896c49854bd2dd79649fc817faf7ecf1d8cffb4983fc2c6a44a6
MD5 e3e5d7148c744de80ae959ba35075c63
BLAKE2b-256 eb51f5cf56a9080aa13ac2a9913050c39ff18ad9635cf9de775bd150e8175291

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