Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MrBotDeveloper/PDF-Bot
A bot for PDF for doing Many Things....
https://github.com/MrBotDeveloper/PDF-Bot
bot datastore docker gcp heroku heroku-deployment heroku-pdf-bot mrbotdeveloper mrdeveloper pdf-files pdf-manipulation pdf-manipulation-utitilies python python-telegram-bot telegram telegram-bot telegram-pdf-bot translation-files
Last synced: 3 months ago
JSON representation
A bot for PDF for doing Many Things....
- Host: GitHub
- URL: https://github.com/MrBotDeveloper/PDF-Bot
- Owner: MrBotDeveloper
- License: mit
- Created: 2021-01-27T04:49:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-04T03:55:40.000Z (3 months ago)
- Last Synced: 2024-08-05T03:04:31.373Z (3 months ago)
- Topics: bot, datastore, docker, gcp, heroku, heroku-deployment, heroku-pdf-bot, mrbotdeveloper, mrdeveloper, pdf-files, pdf-manipulation, pdf-manipulation-utitilies, python, python-telegram-bot, telegram, telegram-bot, telegram-pdf-bot, translation-files
- Language: Python
- Homepage:
- Size: 1.71 MB
- Stars: 70
- Watchers: 2
- Forks: 55
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram PDF Bot
[](https://github.com/MrBotDeveloper)
[](https://github.com/MrBotDeveloper/PDF-Bot)
[](https://github.com/MrBotDeveloper/PDF-Bot/blob/master/LICENSE)
[](https://github.com/psf/black)
[](https://crowdin.com/project/telegram-pdf-bot)
[](https://t.me/NACBots)
[](https://github.com/MrBotDeveloper/PDF-Bot)
A Telegram bot that can:
- Compress, crop, decrypt, encrypt, merge, preview, rename, rotate, scale and split PDF files
- Compare text differences between two PDF files
- Create PDF files from text messages
- Add watermark to PDF files
- Multiple languages support
- Add text layers to PDF files to make them searchable with text
- Extract images and text from PDF files
- Convert PDF files into images
- Beautify handwritten notes images into PDF files
- Convert webpages and images into PDF files
# Repo Special 😅
## What's Special in this repo & To-Do's ???
- [x] ~~Make It Heroku Deployable~~
- [x] ~~Add Detailed Guide to get GCP Credentials~~
- [ ] Add Private Use Feature
- [ ] Add Password feature 🔑 for private use
- [ ] Remove GCP and use another free Cloud Storage.
- [ ] Add Broadcasting Feature
- [ ] Make it more stable and fast
## Mandatory Vars....
```vars.html
DEV_TELE_ID - Your Telegram ID.
TELE_TOKEN - Telegram Bot Token get from @BotFather
GOOGLE_APPLICATION_CREDENTIALS - Your GCP Credentials get from Google Cloud
```
## Where To Get The Mandatory Vars..
```DEV_TELE_ID``` - Get it from [Thunder ⚡ Bot](https://t.me/Thunder_GMBot) by sending ```/id```
```TELE_TOKEN``` - Get it from [@BotFather](https://t.me/BotFather)
```GOOGLE_APPLICATION_CREDENTIALS``` - Get it from [Google Cloud ☁️](https://console.cloud.google.com/freetrial)
## Optional Vars....
```vars.txt
STRIPE_TOKEN - Stripe.com token for receiving Donations.
SLACK_TOKEN - slack.com api token to recieve Feedbacks on Slack.com if not entered you will recieve in your Telegram
```
## Where To Get The Optional Vars...
```STRIPE_TOKEN``` - Get it from [stripe.com](https://stripe.com)
```SLACK_TOKEN``` - Get it from [slack.com](https://api.slack.com/tokens)
## Installation [ ⚠️ Click On Any Topic To Get it's Detailed Information ⚠️]
Getting GCP Ceredinials ⚠️ Important ⚠️
## Getting Started
These instructions will get you a copy of the project up.
### Setup Database
The bot uses [Datastore](https://cloud.google.com/datastore) on Google Cloud Platform (GCP).
**Sir/Ma'am, Kindly 🤗 follow the below steps to create a valid GCP Credentials File :-**
1. Firstly Go to https://console.cloud.google.com/project
2. Create a Project.
3. Open http://console.developers.google.com/project/_/apiui/credential And Click on Create Ceredinials then Click on Service Account.
4. Enter all the required values. [At the Service Accounts, enter a Service account name and click Create. For Service account permissions, select Project, Owner.]
5. Select a service account. Click the 3 skewer bar and select Create Key. Select JSON, click Create.
6. Click Create. The credential file will be downloaded to your local computer or Any Device your are Using.
7. Upload the Project Credential file to the bots private repo.
8. Then Open https://console.cloud.google.com/datastore/setup .
9. And enable the FireStore Database.
10. Now open https://console.cloud.google.com/iam-admin/iam .
11. And set the service account's role to owner. **Note: If you can't see your service account in the list click on Add and add your service account with Owner as Role.**
12. Now Deploy your bot and set ```GOOGLE_APPLICATION_CREDENTIALS``` var with value as the File Name of the Ceredinials Json you uploaded in the repo in Step 7.
13. Congratulations 🎉 your bot has been Successfully Started 😊 So enjoy 🤗.
```alert.txt
⚠️ I will Recommend you to Use Only Google Chrome for generating Ceredinials Json as some browsers will not start the Download of the Json file in the Step 6 ⚠️
```
**Don't Forget to Star 🌟 Repo if ❤️ The Repo and Follow [Me](https://github.com/MrBotDeveloper) to show your ❤️.**
The Easy Way (Heroku)
## Follow these steps for a successful deployment.....
- Star ⭐ the repo 😅 and import it as Private.
- Upload your GCP Credentials in the root directory with name `GCP_FILE.json`
- Click on the Below Deploy Button ✅
[](https://heroku.com/deploy?template=https://github.com/MrBotDeveloper/PDF-Bot/tree/master)
- Enter the Ceredinials and Click in deploy.
- After Deployment Completed Click on Manage App & Turn on the Dynos....
- Booyah!! Your PDF Bot is successfully started.
- Enjoy the Bot 🥳.
## Deploy using GitHub Workflows.....
- Star ⭐ the repo 😅 and import it as Private.
- Upload your GCP Credentials in the root directory with name `GCP_FILE.json`
- Go to Project->Settings->Secrets and Click *New repository secret* and Add All the following Vars as the Repository Secrets.
```HEROKU_API_KEY```: Your Heroku Account API
```HEROKU_APP_NAME``` : Heroku App Name
```HEROKU_EMAIL``` : Your Heroku Email 📨 Id
```DEV_TELE_ID``` : Your Telegram ID.
```TELE_TOKEN``` : Telegram Bot Token get from @BotFather
```GOOGLE_APPLICATION_CREDENTIALS``` : Your GCP Credentials get from Google Cloud
- Go To The Actions Tab and Choose ```Manually Deploy To Heroku``` and click on run workflow.
### Follow [me](https://github.com/MrBotDeveloper) if Love ❣️ the repo.
Local Host
### OS Requirements
Ubuntu
```sh
apt-get install poppler-utils libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 libffi-dev shared-mime-info
```
macOS
```sh
brew install libxml2 libxslt poppler cairo pango gdk-pixbuf libffi
```
### Setup Virtual Environment
Create a virtual environment with the following command:
```sh
virtualenv venv
source venv/bin/activate
```
### Bot Requirements
Run the following command to install the required packages:
```sh
pip install -r requirements.txt
```
### Compile the translation files
Run the following command to compile all the translation files:
```sh
pybabel compile -D pdf_bot -d locale/
```
### Setup Your Environment Variables
Copy the `.env` example file and edit the variables within the file:
```sh
cp .env.example .env
```
### Running The Bot
You can then start the bot with the following command:
```bash
python bot.py
```
### Follow [me](https://github.com/MrBotDeveloper) if Love ❣️ the repo.
## Follow [me](https://github.com/MrBotDeveloper) if Love ❣️ the repo.
## Found a Bug 🐛
```Feel free to create a pull or create a issue now and describe your issue freely.```
## Credits
- [Me 🥰](https://github.com/MrBotDeveloper) For making Deployable To Heroku
- [@zeshuaro](https://github.com/zeshuaro) for his amazing Creation [Telegram PDF Bot](https://github.com/zeshuaro/telegram-pdf-bot)