web-suck-it-py 0.0.2
Python SDK for WebSuckIt integration
License: MIT
Requires Python: >=3.8.1,<4.0.0
Keywords: websocket,communication,http,websuckit,realtime

# web-suck-it-py
Python SDK for websuckit

[![Test CI](https://github.com/WebSuckIt/web-suck-it-py/actions/workflows/test.yml/badge.svg)](https://github.com/WebSuckIt/web-suck-it-py/actions/workflows/test.yml)
[![Deploy to PyPi](https://github.com/WebSuckIt/web-suck-it-py/actions/workflows/deploy.yml/badge.svg)](https://github.com/WebSuckIt/web-suck-it-py/actions/workflows/deploy.yml)
![PyPI - Version](https://img.shields.io/pypi/v/web-suck-it-py)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/web-suck-it-py)

For tutorials and more in-depth information about websuckit Channels, visit
our [official docs](https://docs.websuckit.com).


## Usage Overview

The following topics are covered:
* [Installation](https://github.com/WebSuckIt/web-suck-it-py#installation)
* [Initialization](https://github.com/websuckit/web-suck-it-py#initialization)
* [Channels](https://github.com/WebSuckIt/web-suck-it-py#channel)
    * [Create Channel](https://github.com/WebSuckIt/web-suck-it-py#channel)
    * [Get Channel](https://github.com/WebSuckIt/web-suck-it-py#channel)
    * [Get Channels](https://github.com/WebSuckIt/web-suck-it-py#get-channels-paginated)
    * [Get or Create Channel](https://github.com/WebSuckIt/web-suck-it-py#get-or-create-channel)
    * [Update Channel](https://github.com/WebSuckIt/web-suck-it-py#update-channel)
    * [Delete Channel](https://github.com/WebSuckIt/web-suck-it-py#delete-channel)
    * [Accessing a channel's websocket URL](https://github.com/WebSuckIt/web-suck-it-py#accessing-a-channels-websocket-url)

## Installation

Using poetry

```bash
poetry add web-suck-it-py
```

## Initialization

```py
from web_suck_it_py import WebSuckIt
from os import getenv
handler = WebSuckIt(
    user_id=UUID(getenv("USER_ID")),
    access_key=getenv("ACCESS_KEY"),
    public_key=getenv("PUBLIC_KEY"),
)
```

You can get your `USER_ID`, `ACCESS_KEY` and `PUBLIC_KEY` from the [websuckit dashboard](https://websuckit.com/api-keys).

## Channel

## Accessing a channel's websocket URL

It is possible to access a channel websocket URL by channel name, through the `get_connection_url` function

```py
from web_suck_it_py import GetChannelRequest
connection_url = handler.get_connection_url(
                    channel_name="CHANNEL-NAME",
                    channel_pass_key="CHANNEL-PASS-KEY",
                    replay_self=False,
                 )
```

### Create channel

```py
from web_suck_it_py import CreateChannelRequest
from web_suck_it_py import Channel
channel: Channel = handler.create_channel(
            CreateChannelRequest(
                channel="new-channel-name",
                max_connections=2,
            )
          )
```

### Get channel

```py
from web_suck_it_py import GetChannelRequest
from web_suck_it_py import Channel
channel: Channel = handler.get_channel(
            GetChannelRequest(
                channel_name = "CHANNEL-NAME",
            )
          )
```

### Get channels (paginated)

```py
from typing import List
from web_suck_it_py import GetChannelListRequest
from web_suck_it_py import Channel
channels: List[Channel] = handler.get_channels(
                            GetChannelListRequest(
                                page=0,
                                per_page=10,
                                search_key="search-channel",
                            )
                           )
```

### Get or Create channel

```py
from web_suck_it_py import GetOrCreateChannelRequest
from web_suck_it_py import Channel
channel: Channel = handler.get_or_create_channel(
            GetOrCreateChannelRequest(
                channel_name = "CHANNEL-NAME",
            )
          )
```

### Update channel

```py
from uuid import UUID
from web_suck_it_py import UpdateChannelRequest
from web_suck_it_py import Channel
channel: Channel = handler.update_channel(
                    UpdateChannelRequest(
                        # set to channel id
                        channel_id=UUID(""),
                        regenerate_pass_key=False,
                        # set `channel` to change channel name
                        channel="change-channel-name",
                        # set `max_connections` to change maximum concurrent connections
                        max_connections=5,
                     )
                    )
```

### Delete channel

```py
from uuid import UUID
from web_suck_it_py import DeleteChannelRequest
handler.delete_channel(
    DeleteChannelRequest(
        channel_id=UUID(""),
    )
)
```