User Guides

Practical guides for common tasks and workflows with bfabricPy.

• Creating a Client
  • Creating a Client for Interactive and Scripted Usage
  • Creating a Client for Server and Webapp Usage
  • Choose Your Approach
  • Next Steps
  • See Also
• Reading Data
  • ResultContainer API
  • Entity API
  • Entity Caching
  • Choose Your Approach
  • Quick Comparison
  • See Also
• Writing Data
  • Understanding the Write API
  • Configuration for Testing
  • Core Operations
  • Advanced Operations
  • Common Writable Endpoints
  • Response Handling
  • Real-World Patterns
  • Error Handling
• Entity Features
  • Overview
  • Available Entity Types
  • Datasets
  • Workunits
  • Resources
  • Executables
  • Users
  • Custom Entity Methods
  • Advanced Usage
  • See Also
• bfabric-cli
  • Prerequisites
  • Command Overview
  • Getting Help
  • Common Patterns
  • Confirmation Prompts
  • Command Documentation
• Error Handling
  • ResultContainer Error Handling
  • EntityReader Error Handling
  • See Also

Guides Overview

Guide	Description	Skill Level
Creating a Client	Set up authentication for scripts and web apps	Beginner
Reading Data	Query B-Fabric and retrieve data	Beginner
Writing Data	Create, update, and delete entities	Intermediate
Working with Entities	Use typed entities and relationships	Intermediate
bfabric-cli	Command-line interface for bfabric-cli	All Levels
Error Handling	Error types, patterns, and handling strategies	All Levels

Common Workflows

• Dataset Features - Dataset exports and data access

• Performance Optimization - Cache entities for speed

• CLI Quick Operations - Quick one-off tasks with bfabric-cli

Quick Links

• Quick Start - 5-minute tutorial

• API Reference - Complete API documentation

• Error Handling - Error patterns and solutions

Need Help?

• Check Good to Know for useful tips

• Review API Reference for method details