RingCentral Chatbot Framework for Python
Project description
ringcentral-chatbot-python
RingCentral Chatbot Framework for Python.
pip3 install ringcentral_bot_framework
For js developer, we have ringcentral-chatbot-js
Table of contents
- Features
- Use CLI tool to create an bot app
- Use as a module
- Example bot apps
- Prerequisites
- Development & quick start
- Test bot
- Building and Deploying to AWS Lambda
- Unit Test
- Todos
- License
Features
- Token management
- Token/subscribe auto renew
- Built-in suport for filedb(local development/POC) and AWS dynamodb
- Stateless, built-in suport for AWS lambda
- Define custom bot behavior by
config.py
- Support fully customized db module, loaded when runtime check
DB_TYPE
in.env
- Custom every step of bot lifecycle throught
config.py
, including bot auth, bot webhook
Use CLI tool to create an bot app
- Using ringcentral-chatbot-factory to init a rinncentral chatbot app would be fast!
- require npm 5.2+, recommend using nvm to install nodejs/npm
npx ringcentral-chatbot-factory my-ringcentral-chat-bot
Then just fill the promots, follow my-ringcentral-chat-bot/README.md
's guide, it is done.
Use as a module
Example bot apps
- date-time-chatbot : Simple demo ringcentral chatbot which can tell time/date created with ringcentral-chatbot-framework and ringcentral-chatbot-factory
Prerequisites
- Python3.6+ and Pip3
- Nodejs 8.10+/npm, recommend using nvm to install nodejs/npm
pip3 install python-dotenv ringcentral pydash boto3 flask pylint
- Create the bot App: Login to developer.ringcentral.com and create an
public
Server/Bot
app with permissions:ReadContacts, ReadMessages, ReadPresence, Contacts, ReadAccounts, SMS, InternalMessages, ReadCallLog, ReadCallRecording, WebhookSubscriptions, Glip
Development & quick start
git clone git@github.com:zxdong262/ringcentral-chatbot-python.git
cd ringcentral-chatbot-python
# use virtualenv
pip3 install virtualenv # might need sudo
# init virtual env
virtualenv venv --python=python3
# use env
source ./venv/bin/activate
# install deps
pip install python-dotenv ringcentral pydash boto3 flask pylint
# run ngrok proxy
# since bot need https server,
# so we need a https proxy for ringcentral to visit our local server
./bin/proxy
# will show:
# Forwarding https://xxxxx.ngrok.io -> localhost:8989
# create env file
cp .sample.env .env
# then edit .env, set proper setting,
# and goto your ringcentral app setting page, set OAuth Redirect URI to https://https://xxxxx.ngrok.io/bot-oauth
RINGCENTRAL_BOT_SERVER=https://xxxxx.ngrok.io
## for bots auth required, get then from your ringcentral app page
RINGCENTRAL_BOT_CLIENT_ID=
RINGCENTRAL_BOT_CLIENT_SECRET=
# create custom bot config file, edit custom functions to define bot behavior
cp config.sample.py config.py
# run local dev server
./bin/start
Test bot
- Goto your ringcentral app's bot section, click 'Add to glip'
- Login to https://glip-app.devtest.ringcentral.com, find the bot by searching its name. Talk to the bot.
- Edit config.py to change bot bahavior and test in https://glip-app.devtest.ringcentral.com
Building and Deploying to AWS Lambda
AWS Lambda with API Gateway and DynamoDB would give us a flexible way to deploy the bot.
*Be aware that AWS Lambda ONLY works in linux on an x64 architecture. For non-linux os, we need docker to build dependencies, should install docker first.
Get an AWS account, create aws_access_key_id
and aws_secret_access_key
and place them in ~/.aws/credentials
, like this:
[default]
aws_access_key_id = <your aws_access_key_id>
aws_secret_access_key = <your aws_secret_access_key>
For more information, refer to https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html
cp dev/lambda/serverless.sample.yml devlambda/serverless.yml
Edit lambda/serverless.yml
, and make sure you set the proper name and required env.
# you can define service wide environment variables here
environment:
NODE_ENV: production
# ringcentral apps
## bots
RINGCENTRAL_BOT_CLIENT_ID:
RINGCENTRAL_BOT_CLIENT_SECRET:
## user
RINGCENTRAL_USER_CLIENT_ID: xxxx
RINGCENTRAL_USER_CLIENT_SECRET: xxxx
## common
RINGCENTRAL_SERVER: https://platform.devtest.ringcentral.com
RINGCENTRAL_BOT_SERVER: https://xxxx.execute-api.us-east-1.amazonaws.com/default/poc-your-bot-name-dev-bot
# db
DB_TYPE: dynamodb
DYNAMODB_TABLE_PREFIX: rc_bot2
DYNAMODB_REGION: us-east-1
Deploy to AWS Lambda with bin/deploy
# Run this cmd to deploy to AWS Lambda, full build, may take more time
bin/deploy
## watch Lambda server log
bin/watch
- Create API Gateway for your Lambda function, shape as
https://xxxx.execute-api.us-east-1.amazonaws.com/default/poc-your-bot-name-dev-bot/{action+}
- Make sure your Lambda function role has permission to read/write dynamodb(Set this from AWS IAM roles, could simply attach
AmazonDynamoDBFullAccess
andAWSLambdaRole
policies to Lambda function's role) - Make sure your Lambda function's timeout more than 5 minutes
- Do not forget to set your RingCentral app's redirect URL to Lambda's API Gateway URL,
https://xxxx.execute-api.us-east-1.amazonaws.com/default/poc-your-bot-name-dev-bot/bot-oauth
for bot app.
Unit Test
bin/test
Todos
Visit https://github.com/zxdong262/ringcentral-chatbot-python/issues
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ringcentral_bot_framework-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0be4d10dc1b03b1b64fd27bb3fc82a8684a92fbbcbdd97a9ec1a223d4a329a05 |
|
MD5 | 655b17f3a428823321daa74f65228d0c |
|
BLAKE2b-256 | b1aa10bf10eae6337f2d33f96dc0d297f23f312fbeebcb28fc4828b8c9288581 |
Hashes for ringcentral_bot_framework-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 929a780ccb0e5175ff029c45fe949424f4c3928c550a019450af0c25532d64c3 |
|
MD5 | d0ecf9d28a241493e5cfc846a6613cc0 |
|
BLAKE2b-256 | a277770e736d4ace006e816e2d02ddef002fb9b19246217ddf226ba9b5c4b52e |