Skip to content

AsyncClient

AsyncClient 

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

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.

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 
 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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def __init__(
    self,
    api_key: str | None = None,
    base_url: str = "https://app.bloomgrowth.com/api/v1",
) -> None:
    """Initialize the async Bloomy client.

    Args:
        api_key: The API key for authentication.
        base_url: The base URL for the API.

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

    # 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:

Source code in src/bloomy/async_client.py 
102
103
104
105
106
107
108
109
110
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 
112
113
114
115
116
117
118
119
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 
121
122
123
async def close(self) -> None:
    """Close the HTTP client."""
    await self._client.aclose()