bfabric-app-runner Documentation

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

Documentation Map#

  • Getting Started – Install, configure, and run your first workunit

  • User Guides – Creating apps, working with inputs/outputs, deploying, and the CLI reference

  • Architecture – How the runner orchestrates the dispatch → inputs → process → outputs lifecycle

  • Input / Output / App specifications – Field-level reference for the YAML spec files

  • API Reference – Orientation hub linking the spec references and the Python runner API

  • Workunit Definition – The persisted workunit definition format

  • Resources – Links, contributing, and the changelog

Table of Contents#