Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adam-kad/feedbackbot
Lightweight and efficient feedback bot for Telegram, designed with simplicity in mind and no database required. Perfect for IT professionals looking for a hassle-free solution.
https://github.com/adam-kad/feedbackbot
feedbackbot pytelegrambotapi python telegram telegram-bot
Last synced: about 1 month ago
JSON representation
Lightweight and efficient feedback bot for Telegram, designed with simplicity in mind and no database required. Perfect for IT professionals looking for a hassle-free solution.
- Host: GitHub
- URL: https://github.com/adam-kad/feedbackbot
- Owner: adam-kad
- License: mit
- Created: 2024-07-30T23:36:32.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T13:46:40.000Z (5 months ago)
- Last Synced: 2024-08-03T05:48:19.669Z (5 months ago)
- Topics: feedbackbot, pytelegrambotapi, python, telegram, telegram-bot
- Language: Python
- Homepage:
- Size: 119 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Feedback Bot
Feedback Bot is a Telegram bot designed to provide feedback and assistance. This bot is built using Python and the `pytelegrambotapi` library. You are welcome to contribute and help improve this bot. Visit our [GitHub page](https://github.com/adam-kad/feedbackbot) for more details.
## About the Bot
This bot does not use a database; instead, I aimed to make the bot as simple as possible for use. For adding users to the blacklist, I used a JSON file, but you can customize this as needed. The bot supports both polling and webhook modes.
## Requirements
- Python 3.11+
- Poetry for dependency management
- `pytelegrambotapi` library
## Installation
1. **Clone the repository:**
```sh
git clone https://github.com/adam-kad/feedbackbot.git
cd feedbackbot
```
2. **Install Poetry:**
Follow the instructions on the [Poetry installation page](https://python-poetry.org/docs/#installation).
3. **Install dependencies:**
```sh
poetry install
```
## Configuration
1. **Set up your Telegram bot:**
- Create a new bot using [BotFather](https://core.telegram.org/bots#botfather) and obtain your bot token.
- Create a file named `.env` in the `feedbackbot/config` directory and add your bot token and other configuration settings:
```env
TELEGRAM_BOT_TOKEN=your_bot_token_here
TELEGRAM_WEBHOOK_URL=https://your-webhook-url-here
TELEGRAM_WEBHOOK_PORT=8000
TELEGRAM_GROUP_ID=-2323434
```
2. **Configure webhook (optional):**
- If you are developing locally and want to use webhooks, you need to expose your local server to the internet. You can use [ngrok](https://ngrok.com/) for this purpose. Download and install ngrok, then run:
```sh
ngrok http 8000
```
- Use the generated ngrok URL as your `TELEGRAM_WEBHOOK_URL` and `TELEGRAM_WEBHOOK_PORT` in the `.env` file.
## Usage
1. **Run the bot in polling mode:**
```sh
poetry run python -m bot.main
```
2. **Run the bot in webhook mode:**
```sh
poetry run python -m bot.main --webhook
```
## Contributing
We invite you to contribute and help make this bot better.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Best regards, Feedback Bot