Robin.io-py is a Python SDK built to communicate with the Robinapp API. Now you can integrate Robin.io with minimal effort and quickly setup a real-time messaging platform in your Web application.
Project description
Robin.io-py
Table of contents
Table of Contents
Introduction
Robin.io-py is a Python SDK built to communicate with the Robinapp API. Now you can integrate Robin.io with minimal effort and quickly setup a real-time messaging platform in your Web application.
Prerequisites
The following packages are required to use the sdk:
- Requests
- Websocket-Client
Getting started
Step 1: Create a Robinapp account
A Robinapp account comprises everything required in a chat service including users, message, and api-keys. To create an application:
- Go to the Robinapp Dashboard and enter your email and password, and create a new account.
- Navigate to Api Config and copy your
API key
Note: All the data is limited to the scope of a single user account, thus the users in different Robinapp accounts are unable to chat with each other.
Step 2: Install the Chat SDK
## PIP
pip3 install robin.io-py
Sending your first message
Follow the step-by-step instructions below to authenticate and send your first message.
Authentication
To use the features of the Chat SDK in your client app, a robin
instance must be initiated in each client app before user authentication with Robin server. These instances communicate and interact with the server based on an authenticated user account, allowing for the client app to use the Chat SDK features.
Step 1: Initialize the Chat SDK
To initialize a Robin
instance, pass the API key
as the first argument to in the Robin()
method, You can find your API key in the API Configuration tab in your Robin Account.
Then true
or false
for as the second parameter as it tells the sdk whether to load with ssl or not.
Note: It is recommended to initialize the Chat SDK at the top of your Python file.
robin = Robin("<api_key>", True)
Step 2: Connect to Robin server
You'll need a USER_TOKEN to connect to the Robin server.
A. Create User Token
Create user token
response = robin.create_user_token(data={
"meta_data":{
"name": "Samuel 0.",
}
})
Connect to the Robin server using the USER_TOKEN you just created.
robin.connect(user_token="<api_key>")
Step 3: Channels
All messages sent via Robin are sent through channels, you can consider channels as tunnels that relay messages to all connected clients.
Step 4: Create a conversation
Before we can send a message to a channel we first need to create a converstion.
response = robin.create_conversation(sender_token="<sender_token>", sender_name="<sender_name>", receiver_token="<reciever_token>", receiver_name="<reciever_name>")
Step 5: Send a message to a conversation
Finally, send a message to a conversation.
robin.send_conversation_message(msg={}, channel="<channel_id>", conversation_id="<conversation_id>", sender_token="<sender_token>")
Options
The following are general attributes used in Robin:
Attribute | Type | Default | Description |
---|---|---|---|
Conn | WebSocket | null | Websocket opbject returned after calling robin.connect() |
sender_name | String | '' | Name of the person sending the message |
sender_token | String | '' | USER_TOKEN of the person sending the message |
receiver_name | String | '' | Name of the person receiving the message |
receiver_token | String | '' | USER_TOKEN of the person receiving the message |
msg | Object | {} | Json serializable object containing the message |
If you have any comments or questions regarding bugs and feature requests, visit Robinapp community.
License
Distributed under the MIT License. See LICENSE
for more information.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for robin.io_py-0.0.8-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e52a809ad8e2941b6497884d48bbda09fc0dcbea3fdba254c563ce9278d8ed64 |
|
MD5 | a810ddd634dc70840b24f6470c052ad2 |
|
BLAKE2b-256 | 8c8d69b248e328b60496a3967ccbb7ad178cb307cdb37b110fc873a8e87fd5c1 |