AsyncClient

AsyncClient

AsyncClient(api_key: str | None = None, base_url: str = 'https://app.bloomgrowth.com/api/v1', timeout: float = 30.0)

Asynchronous client for interacting with the Bloomy API.

This client provides async access to all Bloomy API operations including users, meetings, todos, goals, headlines, issues, and scorecards.

Parameters:

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

  The API key for authentication. If not provided, it will be loaded from environment variables or configuration files.

• base_url (str, default: 'https://app.bloomgrowth.com/api/v1' ) –

  The base URL for the API. Defaults to the production API URL.

Example

Using the async client with context manager:

import asyncio
from bloomy import AsyncClient

async def main():
    async with AsyncClient(api_key="your-api-key") as client:
        user = await client.user.details()
        print(user.name)

asyncio.run(main())

Without context manager:

client = AsyncClient(api_key="your-api-key")
user = await client.user.details()
await client.close()

Initialize the async Bloomy client.

Parameters:

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

  The API key for authentication.

• base_url (str, default: 'https://app.bloomgrowth.com/api/v1' ) –

  The base URL for the API.

• timeout (float, default: 30.0 ) –

  The timeout in seconds for HTTP requests. Defaults to 30.0.

Raises:

• ConfigurationError –

  If no API key is provided or found in configuration.

Methods:

• __aenter__ –

  Enter the async context manager.

• __aexit__ –

  Exit the async context manager.

• close –

  Close the HTTP client.

Source code in src/bloomy/async_client.py

def __init__(
    self,
    api_key: str | None = None,
    base_url: str = "https://app.bloomgrowth.com/api/v1",
    timeout: float = 30.0,
) -> None:
    """Initialize the async Bloomy client.

    Args:
        api_key: The API key for authentication.
        base_url: The base URL for the API.
        timeout: The timeout in seconds for HTTP requests. Defaults to 30.0.

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

    """
    config = Configuration(api_key=api_key)

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

    self._client = httpx.AsyncClient(
        base_url=base_url,
        headers={
            "Authorization": f"Bearer {config.api_key}",
            "Content-Type": "application/json",
        },
        timeout=timeout,
    )

    # Lazy imports to avoid circular dependencies
    from .operations.async_.goals import AsyncGoalOperations
    from .operations.async_.headlines import AsyncHeadlineOperations
    from .operations.async_.issues import AsyncIssueOperations
    from .operations.async_.meetings import AsyncMeetingOperations
    from .operations.async_.scorecard import AsyncScorecardOperations
    from .operations.async_.todos import AsyncTodoOperations
    from .operations.async_.users import AsyncUserOperations

    self.user: AsyncUserOperations = AsyncUserOperations(self._client)
    self.meeting: AsyncMeetingOperations = AsyncMeetingOperations(self._client)
    self.todo: AsyncTodoOperations = AsyncTodoOperations(self._client)
    self.goal: AsyncGoalOperations = AsyncGoalOperations(self._client)
    self.headline: AsyncHeadlineOperations = AsyncHeadlineOperations(self._client)
    self.issue: AsyncIssueOperations = AsyncIssueOperations(self._client)
    self.scorecard: AsyncScorecardOperations = AsyncScorecardOperations(
        self._client
    )

Functions

__aenter__ async

__aenter__() -> AsyncClient

Enter the async context manager.

Returns:

• AsyncClient –

  The async client instance.

Source code in src/bloomy/async_client.py

async def __aenter__(self) -> AsyncClient:
    """Enter the async context manager.

    Returns:
        The async client instance.

    """
    await self._client.__aenter__()
    return self

__aexit__ async

__aexit__(exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None) -> None

Exit the async context manager.

Source code in src/bloomy/async_client.py

async def __aexit__(
    self,
    exc_type: type[BaseException] | None,
    exc_val: BaseException | None,
    exc_tb: TracebackType | None,
) -> None:
    """Exit the async context manager."""
    await self._client.__aexit__(exc_type, exc_val, exc_tb)

close async

close() -> None

Close the HTTP client.

Source code in src/bloomy/async_client.py

async def close(self) -> None:
    """Close the HTTP client."""
    await self._client.aclose()

Basic Usage

import asyncio
from bloomy import AsyncClient, ConfigurationError

async def main():
    # Initialize with API key
    async with AsyncClient(api_key="your-api-key") as client:
        users = await client.user.list()

    # Custom base URL (for testing/staging)
    async with AsyncClient(
        api_key="your-api-key",
        base_url="https://staging.example.com/api/v1"
    ) as client:
        users = await client.user.list()

    # Custom timeout (in seconds)
    async with AsyncClient(api_key="your-api-key", timeout=60.0) as client:
        users = await client.user.list()

    # Handle missing API key
    try:
        client = AsyncClient()
    except ConfigurationError as e:
        print(f"Configuration error: {e}")

asyncio.run(main())

Parameters

• api_key (str, optional): Your Bloom Growth API key. If not provided, will attempt to load from BG_API_KEY environment variable or ~/.bloomy/config.yaml
• base_url (str, optional): Custom API endpoint. Defaults to "https://app.bloomgrowth.com/api/v1"
• timeout (float, optional): Request timeout in seconds. Defaults to 30.0

Exceptions

• ConfigurationError: Raised when no API key can be found from any source

Context Manager

The AsyncClient supports async context manager protocol for automatic resource cleanup:

async with AsyncClient(api_key="your-api-key") as client:
    users = await client.user.list()
    # Client automatically closes when exiting the context