Skip to main content
Ctrl+K

bfabricPy 1.17.0 documentation

  • Getting Started
    • Installation
    • Quick Start
    • Configuration
    • Troubleshooting
  • User Guides
    • Creating a Client
      • Creating a Client for Interactive and Scripted Usage
      • Creating a Client for Server and Webapp Usage
    • Reading Data
      • ResultContainer API
      • Entity API
      • Entity Caching
    • Writing Data
    • Entity Features
    • bfabric-cli
      • API Operations
      • API Inspection with CLI
      • Datasets
      • Executables
      • Workunits
      • Feeder
    • Error Handling
  • API Reference
    • Bfabric Client API Reference
    • API Reference: Entity Types
    • API Reference: EntityReader
    • API Reference: EntityUri
    • ResultContainer API Reference
    • API Reference: Token Data
    • API Reference: Exceptions and Errors
  • Advanced Topics
    • Experimental: Workunit Definitions
    • Experimental Data Operations
  • Resources
    • Good to Know
    • Changelog
  • .md

bfabricPy Documentation

Contents

  • Table of Contents

bfabricPy Documentation#

bfabricPy provides a Python interface to the B-Fabric system.

This documentation is organized primarily by what you want to do rather than by API structure:

  • Getting Started - Installation, configuration, first script

  • User Guides - Task-based tutorials and examples

  • API Reference - Complete, auto-generated documentation

  • Advanced Topics - Advanced features and patterns

  • Resources - Error handling, best practices, contributing

Table of Contents#

  • Getting Started
    • Installation
    • Quick Start
    • Configuration
    • Troubleshooting
    • Next Steps
    • Quick Links
  • User Guides
    • Creating a Client
    • Reading Data
    • Writing Data
    • Entity Features
    • bfabric-cli
    • Error Handling
    • Guides Overview
    • Common Workflows
    • Quick Links
    • Need Help?
  • API Reference
    • Bfabric Client API Reference
    • API Reference: Entity Types
    • API Reference: EntityReader
    • API Reference: EntityUri
    • ResultContainer API Reference
    • API Reference: Token Data
    • API Reference: Exceptions and Errors
    • Documentation Style
    • Quick Links
    • For Beginners
    • Finding What You Need
    • API Stability
    • Contributing to Documentation
    • Next Steps
  • Advanced Topics
    • Experimental: Workunit Definitions
    • Experimental Data Operations
    • Topics Overview
    • Advanced Guides
    • Related Documentation
  • Resources
    • Good to Know
    • Changelog
    • Overview
    • Quick Links

next

Getting Started

Contents
  • Table of Contents

By the bfabricpy authors

© Copyright 2014-2026 Functional Genomics Center Zurich.