Skip to content

Client

The main entry point for interacting with the Bloomy API.

Client 

Client(api_key: str | None = None)

The Client class is the main entry point for interacting with the Bloomy API.

It provides methods for managing Bloom Growth features.

Example 
from bloomy import Client
client = Client()
client.meeting.list()
client.user.details()
client.meeting.delete(123)
client.scorecard.list()
client.issue.list()
client.headline.list()

Initialize a new Client instance.

Parameters:

  • api_key (str | None, default: None ) –

    The API key to use. If not provided, will attempt to load from environment variable (BG_API_KEY) or configuration file.

Raises:

  • ValueError –

    If no API key is provided or found in configuration.

Methods:

  • __enter__ –

    Context manager entry.

  • __exit__ –

    Context manager exit - close the HTTP client.

  • close –

    Close the HTTP client connection.

Source code in src/bloomy/client.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def __init__(self, api_key: str | None = None) -> None:
    """Initialize a new Client instance.

    Args:
        api_key: The API key to use. If not provided, will attempt to
                 load from environment variable (BG_API_KEY) or configuration file.

    Raises:
        ValueError: If no API key is provided or found in configuration.

    """
    # Use Configuration class which handles priority:
    # 1. Explicit api_key parameter
    # 2. BG_API_KEY environment variable
    # 3. Configuration file (~/.bloomy/config.yaml)
    self.configuration = Configuration(api_key)

    if not self.configuration.api_key:
        raise ValueError(
            "No API key provided. Set it explicitly, via BG_API_KEY "
            "environment variable, or in ~/.bloomy/config.yaml configuration file."
        )

    self._api_key = self.configuration.api_key
    self._base_url = "https://app.bloomgrowth.com/api/v1"

    # Initialize HTTP client
    self._client = httpx.Client(
        base_url=self._base_url,
        headers={
            "Accept": "*/*",
            "Content-Type": "application/json",
            "Authorization": f"Bearer {self._api_key}",
        },
        timeout=30.0,
    )

    # Initialize operation classes
    self.user = UserOperations(self._client)
    self.todo = TodoOperations(self._client)
    self.meeting = MeetingOperations(self._client)
    self.goal = GoalOperations(self._client)
    self.scorecard = ScorecardOperations(self._client)
    self.issue = IssueOperations(self._client)
    self.headline = HeadlineOperations(self._client)

Functions

__enter__ 

__enter__() -> Client

Context manager entry.

Returns:

  • Client –

    The client instance.

Source code in src/bloomy/client.py 
87
88
89
90
91
92
93
94
def __enter__(self) -> Client:
    """Context manager entry.

    Returns:
        The client instance.

    """
    return self

__exit__ 

__exit__(*args: Any) -> None

Context manager exit - close the HTTP client.

Source code in src/bloomy/client.py 
96
97
98
def __exit__(self, *args: Any) -> None:
    """Context manager exit - close the HTTP client."""
    self._client.close()

close 

close() -> None

Close the HTTP client connection.

Source code in src/bloomy/client.py 
100
101
102
def close(self) -> None:
    """Close the HTTP client connection."""
    self._client.close()