https://github.com/thesarthakjain/telegram_bot

This is a personal telegram bot. Hosted locally on a 'Raspberry Pi 4 Model-B 4GB' and an 'Android Mobile Device' (for battery backup).
https://github.com/thesarthakjain/telegram_bot

bot python raspberry-pi telegram telegram-bot telegram-bot-api

Last synced: about 1 month ago
JSON representation

This is a personal telegram bot. Hosted locally on a 'Raspberry Pi 4 Model-B 4GB' and an 'Android Mobile Device' (for battery backup).

• Host: GitHub
• URL: https://github.com/thesarthakjain/telegram_bot
• Owner: thesarthakjain
• Created: 2021-11-01T10:49:35.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-14T06:44:12.000Z (almost 2 years ago)
• Last Synced: 2024-06-28T17:48:23.256Z (3 months ago)
• Topics: bot, python, raspberry-pi, telegram, telegram-bot, telegram-bot-api
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 8
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        


	
 Telegram Bot 


## Description

This is a telegram bot that can be used as a template for personal telegram bot.

## Telegram API Token Generation

1. First you will need to create a personal telegram account and then search for `@BotFather`. Then type the command - `/newbot`

1. After that, enter the `username` for the bot.

1. The `@BotFather` will give you the API Token for the bot.

## Getting started with the Telegram-Bot

1. Make sure you are in the project directory: 

        cd /path/to/telegram_bot

        

2. Install the requirements: 

        pip3 install -r requirements.txt

3. Creating `config.yaml` file manually - This step could be skipped as running the bot without this file will automatically generate it for you.

	```yaml

	token: 

	bot_admin: 

	trusted_users: 

	```

	The `bot.py` will also generate the `saved` folder inside the project directory. 

	All the files that the trusted_users and admins send to the bot via telegram chat will be stored here.

4. Run the bot: 

        python3 bot.py

5. To Stop the bot: 

        ctrl + c

## Bot Functions

#### There are 3 levels of privileges for the functions:

1. General User - U

1. Trusted User - TU

1. Admin - AU

|Function Name|Description|Privilege|

|:---|:---|:---:|

|   /start |   Welcome message |    U   |

|   /help  |   help message    |   U   |

|   /contact    |   Bot Admin Info  |   U   |

|   /ig_dp `` |   Download Instagram DP   |   U   |

|   /list   |   List all the saved files    |   TU   |

|   /print `` |   Print a saved file  |   TU  |

|   /print_range `` `` |   Print a range of pages from a saved file  |   TU  |

|   Upload a file | Downloads and saves the file locally | TU |

| /add_trusted `` | Add new trusted user to list | AU |

| /add_admin `` | Add new bot admin to list | AU |