https://github.com/qdot/np-telegram-bot
Base code for NP Labs Telegram bots
https://github.com/qdot/np-telegram-bot
Last synced: 3 months ago
JSON representation
Base code for NP Labs Telegram bots
- Host: GitHub
- URL: https://github.com/qdot/np-telegram-bot
- Owner: qdot
- License: bsd-3-clause
- Created: 2016-06-02T05:21:47.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-23T07:10:43.000Z (about 10 years ago)
- Last Synced: 2025-03-11T21:27:18.553Z (over 1 year ago)
- Language: Python
- Size: 86.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NP Telegram Bot
NP Telegram Bot is a simple code base for building bots with a few
predefined features on top of the
[python-telegram-bot](http://github.com/python-telegram-bot/python-telegram-bot)
API.
NP Telegram Bot offers the following modules on top of python-telegram-bot:
- User tracking with flags - Allows developers to create different
user privileges for accessing bot actions and features.
- Group Tracking - Keeps a list of what groups the bot is in (how does
telegram not have this as a feature yet?!), allows bot
administrators to broadcast messages into all groups bot is
currently a member of.
- Conversation Tracking - Uses python generators to make holding
asynchronous conversations with users simple and painless.
# Why use this versus python-telegram-bot alone?
NP Telegram Bot was influenced heavily by the developers decades on
IRC, using eggdrop/grufti/supybot/etc. Whether this is good or bad is
anyone's guess, since Telegram definitely is not IRC.
Anyways, if you're just planning to make a simple inline bot that will
access a web API and return results, then using this is overkill. Just
go with python-telegram-bot.
However, for anyone that wants to host a IRC style bot that will
remember users, take input, have conversations, and maintain state
between sessions, NP Telegram Bot provides some handy tools for
getting up and running quickly.
# Requirements
Requirements for NP Telegram Bot are:
- Python 3 (tested on 3.5, but should work on 3.3+, and maybe even earlier)
- Redis backing store (Though could easily be swapped out with something else)
# Bots using NP Telegram Bot
- [Mowcounter](http://github.com/qdot/mowcounter-telegram-bot) -
Simple chat focused bot that counts phrase usage among users and
keeps a high score table.
# License
BSD 3-Clause License, see [LICENSE](LICENSE) file for more info.
Copyright (c) 2016, Kyle Machulis/qDot
All rights reserved.