This repository has been archived by the owner on Oct 14, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README.md for better documentation
- Loading branch information
1 parent
499022e
commit ab846f4
Showing
1 changed file
with
71 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,72 @@ | ||
# Multi-funtional-telegram-bot | ||
This Bot is the multifunctional bot. Use it to check weather, convert JPG to PDF, check emails, tell jokes and much more | ||
## Usage and need of this bot | ||
This bot can automate these following tasks | ||
|
||
1. Convert photos to PDF: When the user sends the command "/jpg2pdf", the bot converts all the photos in the "tempimg" folder to PDFs and saves them in the "temppdf" folder. Then, the bot merges all the PDFs into a single PDF named "merged.pdf" and sends it to the user. Finally, the bot deletes all the temporary files. | ||
|
||
2. Check unread emails: When the user sends the command "/check_email", the bot logs in to the user's Gmail account, checks the number of unread emails in the inbox, and replies to the user with the number of unread emails. | ||
|
||
3. Tell a joke: When the user sends the command "/tell_joke", the bot reads a random joke from a text file named "joke.txt" and sends it to the user. | ||
|
||
4. Weather information: When the user sends the command "/weather", the bot asks the user to set the city. Then, when the user sends the city name, the bot retrieves the current weather information of the city from the OpenWeatherMap API and sends it to the user. If the weather is "broken clouds", the bot sends a photo of broken clouds to the user. | ||
|
||
5. Greeting: When the user sends the command "/start", the bot greets the user with "Hey! Hows it going?" | ||
|
||
## Links | ||
[Releases](https://github.com/Philotheephilix/Multi-funtional-telegram-bot/releases) | ||
|
||
|
||
[Contributors](https://github.com/Philotheephilix/Multi-funtional-telegram-bot/graphs/contributors) | ||
|
||
## Introduction | ||
This library provides a pure Python, code for the Telegram Bot . It's completely made with Python 3 | ||
|
||
Introducing a Python-based Telegram bot that is designed to simplify your messaging experience on the popular platform. This bot is built using the Telegram Bot API and can be easily installed and deployed on any machine that runs Python. | ||
|
||
This bot provides an easy-to-use interface that allows users to interact with the Telegram platform using a set of pre-defined commands. Whether you want to send messages, images, or documents, this bot has got you covered. | ||
|
||
The bot is designed with modularity in mind, meaning it is built using a set of self-contained modules that can be easily extended or modified to fit your specific use case. Some of the core modules used in the bot include the python-telegram-bot library for interacting with the Telegram Bot API, requests module for making HTTP requests, os module for working with the operating system | ||
|
||
Overall, this Telegram bot is a powerful and versatile tool that can help streamline your messaging experience on the platform. Its modular design make it a great choice for anyone looking to build custom solution for performing routine tasks with single click on Telegram. | ||
|
||
|
||
|
||
## Installing | ||
### 1. You need to create a telegram bot first follow steps given below to get started | ||
BotFather is the official bot used to create and manage Telegram bots. Here are the steps to create a bot using BotFather: | ||
|
||
1.Open Telegram and search for BotFather in the search bar. | ||
|
||
2.Click on the BotFather and then click on the "Start" button. | ||
|
||
3.Type /newbot command to create a new bot. | ||
|
||
4.Give a name to your bot and choose a username for it. The username should end with "bot". For example, MyTestBot. | ||
|
||
5.BotFather will then give you an API token that you will use to communicate with your bot. Save this token somewhere safe as you will need it later. | ||
|
||
HOORAY Your bot is now created and ready to be configured. | ||
|
||
2.Clone this repository on your local machine | ||
|
||
3.install these modules in python using pip | ||
|
||
telebot | ||
|
||
pillow | ||
|
||
pypdf (version 2.0 as latest 3.0 has some issues) | ||
|
||
4. Configure email and API tokens | ||
|
||
5.Run this script in Python IDLE or in some IDE | ||
|
||
|
||
|
||
## Security | ||
Our goal is to provide secure environment so we have no unneccessary online communication like analytics it's just standalone on your desk | ||
As we give our E-Mail id to our bot we don't know how secure is this we are working on that to improvise the privacy. | ||
|
||
|
||
## Disclaimer | ||
Anyone can download or copy our code to use and redistribute but if you copy the whole code to someother projects kindly don't forget to give credits |