https://github.com/sendbird/sendbird-platform-sdk-python
Sendbird Platform API SDK for server languages
https://github.com/sendbird/sendbird-platform-sdk-python
Last synced: 6 months ago
JSON representation
Sendbird Platform API SDK for server languages
- Host: GitHub
- URL: https://github.com/sendbird/sendbird-platform-sdk-python
- Owner: sendbird
- License: mit
- Created: 2022-02-04T12:18:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T09:03:25.000Z (over 1 year ago)
- Last Synced: 2025-04-24T06:54:37.285Z (about 1 year ago)
- Language: Python
- Size: 2.13 MB
- Stars: 11
- Watchers: 20
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Sendbird Python Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
[](/docs)
[](https://pypi.org/project/sendbird-platform-sdk)
This is a python library that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier. With this library you can extend your Sendbird integration to include advanced features like channel automation and user management.
# 🔥 Quick start
```python
import sendbird_platform_sdk
from sendbird_platform_sdk.api import user_api
from pprint import pprint
configuration = sendbird_platform_sdk.Configuration(
host = "https://api-YOUR_APP_ID_FROM_DASHBOARD.sendbird.com"
)
with sendbird_platform_sdk.ApiClient(configuration=configuration) as api_client:
api_instance = user_api.UserApi(api_client)
api_token = "YOUR_MASTER_API_TOKEN_FROM_DASHBOARD"
try:
api_response = api_instance.list_users(api_token=api_token, limit=1)
pprint(api_response)
except sendbird_platform_sdk.ApiException as e:
print("Exception when calling UserApi->list_users: %s\n" % e)
```
# ⚒️ Prerequisite
In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/). Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
# 💻 Requirements
This package has been tested with python version 3.9.10
# ⚙️ Installation
Using pip
```bash
pip install sendbird-platform-sdk
```
# 🤓 Local Development
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
# 🗃️ Documentation
All the documentation for this project lives in the /docs directory of this repo.
##### Helpful links
| | Documentation |
| ----------- | ----------- |
| Announcement | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|
| Bot | [docs/BotApi.md](docs/BotApi.md) |
| GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md) |
| Message | [docs/MessageApi.md](docs/MessageApi.md) |
| OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md) |
| User | [docs/UserApi.md](docs/UserApi.md) |
| Moderation | [docs/ModerationApi.md](docs/ModerationApi.md) |