Flywheel Developer Toolkit

Introduction

The Flywheel Developer Toolkit is a collection of open-source Python packages maintained by Flywheel that help developers build solutions and integrate with the Flywheel platform. These libraries provide standardized interfaces for common tasks such as API communication, file handling, gear development, and data classification.

This section provides an overview of the key packages in the Flywheel Developer Toolkit and how they can be used to build powerful integrations with Flywheel.

Key Packages

fw-client

A robust HTTP client for the Flywheel API with built-in error handling and retry mechanisms. This package provides a reliable foundation for applications that need to communicate with Flywheel.

fw-file

A unified interface for working with various file formats commonly used in neuroimaging and medical research. This package simplifies file parsing, metadata extraction, and format conversion.

fw-gear

A toolkit for developing Flywheel gears (containerized algorithms) with standardized interfaces for accessing inputs, outputs, and configuration. This package makes gear development more efficient and consistent. Note: This package is currently in beta status and is replacing the older gear-toolkit package.

fw-curation

A library for simplifying bulk curation tasks on the Flywheel hierarchy with configurable traversal tools and multiprocessing support. This package helps data managers and developers perform large-scale operations across projects, subjects, sessions, and acquisitions efficiently.

fw-classification

A library for classifying medical imaging data based on configurable rules and profiles. This package enables automated organization and labeling of data within Flywheel.