API Reference

API Reference#

Complete API documentation for all bfabricPy classes and methods.

Documentation Style#

This section uses auto-generated documentation directly from the Python code using Sphinx autodoc and autodoc_pydantic extensions. This ensures:

✅ Documentation is always in sync with the code ✅ Type signatures are accurate ✅ Parameters and return types are complete ✅ No redundant manual maintenance

For Beginners#

If you’re new to bfabricPy, start with:

  1. Quick Start Tutorial - 5-minute tutorial

  2. User Guides - Task-based guides

  3. Then return here for detailed API reference

Finding What You Need#

By Task#

Task

Relevant Documentation

Create a client

Bfabric Client, Getting Started

Query B-Fabric

Bfabric Client: read(), EntityReader

Work with entities

Entity Types, EntityReader

Write data

Bfabric Client: save()

Handle errors

Exceptions & Errors

By Class#

Class

What It Does

Bfabric

Main client - all API operations

Entity

Base class for all B-Fabric entities

EntityReader

Read entities by URI/ID/query

ResultContainer

Container for query results

EntityUri

Entity identifier across instances

TokenData

Token authentication data

BfabricRequestError

Server-side errors

BfabricConfigError

Configuration errors

API Stability#

bfabricPy follows semantic versioning (X.Y.Z):

  • Major changes (X): May include breaking changes, announced in changelog

  • Minor changes (Y): New features, backward compatible

  • Patch changes (Z): Bug fixes, backward compatible

For version history and deprecation notices, see Changelog.

Contributing to Documentation#

Documentation is generated from docstrings in the code. To improve it:

  1. Add docstrings to public classes, methods, and functions

  2. Update docstrings when changing behavior

  3. Run documentation build to see changes

  4. Commit documentation changes along with code changes

See Contributing Guide for more details.

Next Steps#

Contents