bfabric-app-runner Documentation

bfabric-app-runner provides a framework for developing and running applications that integrate with the B-Fabric system. It handles workunit processing, input/output staging, and app execution lifecycle.

Installation

To install the most recent released version:

uv tool install bfabric_app_runner

To install a development version:

uv tool install bfabric_app_runner@git+https://github.com/fgcz/bfabricPy.git@main#egg=bfabric_app_runner&subdirectory=bfabric_app_runner

Table of Contents

• Getting Started
  • Installation
  • Quick Start
  • Configuration
  • Quick Links
• User Guides
  • Creating an App
  • Deploying Apps
  • Working with Inputs
  • Working with Outputs
  • Python Environments
  • CLI Reference
  • Guides Overview
  • Common Workflows
• Architecture Overview
  • What is bfabric-app-runner?
  • Workflow Phases
  • Key Components
  • How Chunks Work
  • Action Types
  • Dispatch Strategies
  • App model
  • App runner activity diagram
• Input specification
  • General structure
• Commands
  • Validation
  • Prepare files
  • List files
• Reference
  • InputsSpec
• Output specification
  • General structure
• Commands
  • Validation
  • Register files
• Reference
  • CopyResourceSpec
  • OutputsSpec
  • SaveDatasetSpec
  • SaveLinkSpec
  • UpdateExisting
• App Specification
  • Overview
  • App Specification Structure
  • Commands
  • App Versions
  • Variables and Templating
  • Loading and Using App Specifications
  • Reference
• API Reference
  • App Specification
  • Input Specifications
  • Output Specifications
  • Runner
• Resources
  • Changelog
  • Links
  • Contributing
• Workunit Definition
  • Creating WorkunitDefinition instances
  • Workunit references
  • Reference
• Changelog
  • [Unreleased]
  • [0.6.0] - 2026-04-20
  • [0.5.1] - 2026-03-02
  • [0.5.0] - 2025-12-15
  • [0.4.0] - 2025-09-26
  • [0.3.1] - 2025-09-01
• Changed
  • [0.3.0] - 2025-08-26
  • [0.2.1] - 2025-07-22
  • [0.2.0] - 2025-07-15
  • [0.1.2] - 2025-07-08
  • [0.1.1] - 2025-07-07
  • [0.1.0] - 2025-06-27
  • [0.0.23] - 2025-06-02
  • [0.0.22] - 2025-05-21
  • [0.0.21] - 2025-03-27
  • [0.0.20] - 2025-03-25
  • [0.0.19] - 2025-02-28
  • [0.0.18] - 2025-02-25
  • [0.0.17] - 2025-02-19
  • [0.0.16] - 2025-02-19
  • [0.0.15] - 2025-02-06
  • [0.0.14] - 2025-01-30
  • [0.0.13] - 2025-01-28
  • [0.0.12] - 2025-01-22
  • Added
  • [0.0.11] - 2025-01-16
  • [0.0.10] - 2025-01-15
  • [0.0.9] - 2025-01-09
  • [0.0.8] - 2025-01-08
  • [0.0.7] - 2024-11-22
  • [0.0.6] - 2024-11-14
  • [0.0.5] - 2024-11-11
  • [0.0.4] - 2024-11-11
  • [0.0.3] - 2024-10-24
  • [0.0.2] - 2024-10-23