Client Module

class pypufferblow.client.Client(options: ClientOptions)

The pufferblow client object.

This class provides methods to interact with the pufferblow API, including user and channel management.

users

The Users object for managing users.

Type:

Users

channels

The Channels object for managing channels.

Type:

Channels

Example

>>> from pypufferblow.client import Client, ClientOptions
>>> client_options = ClientOptions(
...    host="localhost",
...    port=7575,
...    username="user1",
...    password="SUPER_SERCRET_PASSWORD"
... )
>>> client = Client(client_options)

channels() → Channels

Create a Channels object for communicating with the channels routes.

Returns:

The Channels object for managing channels.

Return type:

Channels

users() → Users

Create a Users object for communicating with the users routes.

Returns:

The Users object for managing users.

Return type:

Users

class pypufferblow.client.ClientOptions(user: UserModel | None = None, **kwargs)

ClientOptions class used for managing the Client object options.

to_channels_options() → ChannelsOptions

Convert to ChannelsOptions object.

Returns:

The ChannelsOptions object.

Return type:

ChannelsOptions

to_users_options() → UsersOptions

Convert to a UsersOptions object.

Returns:

The UserOptions object.

Return type:

UserOptions