معرفی شرکت ها
EasyTeleBot-0.0.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Configurable Telegram Bot package
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | EasyTeleBot-0.0.4 |
| نام | EasyTeleBot |
| نسخه کتابخانه | 0.0.4 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Ido Zahavy |
| ایمیل نویسنده | idozahavy@gmail.com |
| آدرس صفحه اصلی | https://github.com/idozahavy/EasyTeleBot |
| آدرس اینترنتی | https://pypi.org/project/EasyTeleBot/ |
| مجوز | - |
# EasyTeleBot
EasyTeleBot is a package for creating an automated bot responder for telegram in python.
The program uses flask and webhook to get user messages from telegram.
## Installation
Install the package by entering in terminal
`pip install easytelebot`
Package Dependencies:
- flask
- python-telegram-bot
## Usage
`import EasyTeleBot`
After importing the EasyTeleBot get the config json file in one of two ways:
1. As string path `config_file = "config_file.json"`
1. As IO readable `config_file = open("config_file.json")`
1. As a **list** of the two above `config_files = [config_file1, config_file2]`
Use CreateEasyTelegramBot to create the bot it will create the whole bot automatically.
`bot = EasyTeleBot.CreateEasyTelegramBot(config_file)`
Inside this class lays a flask app which you can get by typing - `bot.flask_app`.
Run this flask app to start handling the messages telegram is sending to the bot (user message go through telegram servers).
Tested WSGI Usages:
- [x] gunicorn `gunicorn myapp:bot.flask_app`
- [ ] nginx
- [ ] Django
Telegram bot chats start with the word `"/start"` so you should enter this kind of action
## Config File
Create a config file in json format according to these rules :
1. **"telegram_token"** - Is the telegram api token you get after creating a new bot through [BotFather](https://telegram.me/BotFather).
1. **"webhook_url"** - This is the url to tell telegram servers to forward the messages users send to bot chat,
typically it will be the server url beginning and an identifier.
example: `"https://example-server.herokuapp.com/example-identifier"`.
The bot listens to this url.
1. **"bot_name"** - Your bot name. Will make the flask server with this name.
1. [**"actions"**](https://github.com/idozahavy/EasyTeleBot#action) - A list of actions to configure the bot behavior.
Optional:
- **"default_action_id"** - If no action triggers this action id will perform.
#### Example config_file.json
```
{
actions:[
...
]
"telegram_token": "example_token:KG5Gdv6AK05aeGctf25",
"webhook_url": "https://example-server.herokuapp.com/example-identifier",
"bot_name": "example_bot",
"default_action_id": 50621
}
```
## Action
Each action has these attributes:
1. **"id"** - Action identifier.
1. **"triggers"** - List of user messages that initiate this action.
1. [**"type"**](https://github.com/idozahavy/EasyTeleBot#action-types) - The type of action. Each type of action does a different thing.
1. **"data"** - The data of the function (read [Action Types](https://github.com/idozahavy/EasyTeleBot#action-types) to better understand).
If there is a format, it will try to extract saved information, example `"{data.name}"` will change to the value saved in `"name"`.
`"{data.last_text_received}"` will change into the last text message the user sent to chat.
Optional attributes:
- **"next_action_id"** - Do this ids action right after the this action finishes.
- **"follow_up_action_id"** - The follow up action id, does this after the user sends back a message. This is for question actions.
- **"markup_type"** - When sending a markup, the users chat will have options to press, like `"/start"` and `"/help"`.
Every `','` will separate between words and every `':'` will separate between rows.
- **"remove"** - Removes the previous markup the users chat has.
- **"reply"** - Sends the markup to the user, when the user presses on one, it minimizes it.
- **"static-reply"** - Sends the markup to the user, it will stay until you remove it.
- **"markup_data"** - If `"markup_type"` is `"reply"` or `"static-reply"`, uses this to make a list of reply keyboard options.
**Do not** use both `"next_action_id"` and `"follow_up_action_id"` in the same action. Use only one of them or none.
#### Example action
```
...
{
"id": 1,
"triggers": ["hi", "hello", "hey"],
"type": "text",
"data": "server says hello back",
"next_action_id": 2
},
{
"id": 2,
"triggers": [],
"type": "text",
"data": "server got to this action right after action id 1, now you got markup options",
"markup_type": "reply",
"markup_data": "left top,right top:left bottom,right bottom"
},
...
```
## Action Types
### text
Sends back a message containing `"data"`.
```
...
"triggers": ["hi", "hello", "hey"],
"type": "text",
"data": "server says hello back",
...
```
### animation
Sends back an animation where `"data"` is the url of the animation.
Converts all to gifs.
```
...
"triggers": ["puppy"],
"type": "animation",
"data": "https://media.giphy.com/media/5awVf7q1nwkus/giphy.gif",
...
```
### save
Saves the value that is in `"data"` into `"save_to_data_name"`.
```
...
"triggers": ["save 'ok' into 'blop' data name"],
"type": "save",
"data": "ok",
"save_to_data_name": "blop"
...
```
Usually **you should** use it to save user input like this example:
```
...
{
"id": 1,
"triggers": ["save my name"],
"type": "text",
"data": "please enter your name",
"follow_up_action_id": 2
},
{
"id": 2,
"triggers": [],
"type": "save",
"data": "{data.last_text_received}",
"save_to_data_name": "name",
"next_action_id": 3
},
{
"id": 3,
"triggers": [],
"type": "text",
"data": "your name is {data.name}",
},
```
### calculate
Calculates the expression in `"data"` using math and saving it into `"calculate_result"`.
```
...
{
"id": 1
"triggers": ["calculate expression"],
"type": "calculate",
"data": "5^5",
"next_action_id": 2
},
{
"id": 2,
"triggers": [],
"type": "text",
"data": "5^5 = {data.calculate_result}"
}
...
```
نیازمندی
| مقدار | نام |
|---|---|
| - | flask |
| - | python-telegram-bot |
| - | pandas |
| - | numpy |
| - | StringCalculator |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6 | Python |
نحوه نصب
نصب پکیج whl EasyTeleBot-0.0.4:
pip install EasyTeleBot-0.0.4.whl
نصب پکیج tar.gz EasyTeleBot-0.0.4:
pip install EasyTeleBot-0.0.4.tar.gz