Overview

The BDK API is the core Python library in the Book Development Kit (BDK). It enables developers to build a Book. This reference covers the essential elements for working with the BDK API, from foundational concepts to advanced features.

Key Components

1. Concepts

Learn how concepts define how data flows into and out of operations.

2. Connections

Set up and manage connections with third-party tools and services in your Book.

3. Docstrings

Understand how to format and write docstrings to ensure your Book is well-documented.

4. Decorators

The BDK API provides several decorators that allow you to customize the functionality of various components within a Book:

@book

@concept

@config

@connect

@oauth

@oauth_token

@procedure

5. Enums

The BDK includes the following enumeration types:

FilterBinaryOperator

FilterUnaryOperator

OAuthFlow

OAuthProvider

6. Filter Expressions

Learn about implementing filter expressions.

7. Noun Phrases

Learn about the concept of a noun phrase.

8. Operations

Learn how to implement an operation in your Book.