https://github.com/leam-tech/frappe_telegram

Telegram Bot support for Frappe / ERPNext.
https://github.com/leam-tech/frappe_telegram

bot erpnext frappe telegram telegram-bot telegram-bot-api

Last synced: 4 months ago
JSON representation

Telegram Bot support for Frappe / ERPNext.

• Host: GitHub
• URL: https://github.com/leam-tech/frappe_telegram
• Owner: leam-tech
• License: other
• Created: 2021-07-24T06:37:20.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-15T08:49:19.000Z (11 months ago)
• Last Synced: 2024-05-15T20:07:29.304Z (7 months ago)
• Topics: bot, erpnext, frappe, telegram, telegram-bot, telegram-bot-api
• Language: Python
• Homepage:
• Size: 536 KB
• Stars: 29
• Watchers: 8
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

• awesome-frappe - Telegram Bot Manager - Telegram Bot support for Frappe. (Uncategorized / Uncategorized)

README

        
## Frappe Telegram

Telegram Bot Manager for Frappe. This is a wrapper around [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) tuned for frappe. Please go through the documentations of `python-telegram-bot` to easily customize your bot.

### Features

- Frappe Context for each incoming Updates

- Multi Bot support

- Runs the bot independently from the web server process

- Custom Bot implementations via Hooks

- Frappe User Login

- Frappe User signup

- Tracks Chats and contained messages

- Supports sending messages from bot via frappe hooks / controller methods

- Integration with frappe `Notification` doctype

### DocTypes

- `Telegram Bot`  

Add all your telegram-bots here with their `api-tokens`

- `Telegram User`  

Any telegram-user that interacts with your bot comes here. Authentication is when `Telegram User` is linked to frappe's `User`

- `Telegram Chat`  

All private chats, groups where the bot gets notified comes here

- `Telegram Message`  

All messages - incoming & outgoing gets logged here

### Page

- `Telegram Chat View`  

A simple chat-page within frappe just for your telegram-bots

### Guides

- [Basic Setup](./docs/basic_setup.md)

- [User Authentication](./docs/auth.md)

- [Running in DEV mode](./docs/dev_setup.md)

- [Supported Hooks for Customization](./docs/hooks.md)

- [Setting up for Production](./docs/production.md)

- [Using Frappe Notifications DocType](./docs/frappe-notifications.md)

- [Meta Conversation Driver](./docs/meta_conversation_driver.md)

- [Example: Login Notifier](./docs/login_notifier.md)

- [Example: Activity Notifier](./docs/activity_notifier.md)

#### License

MIT