Getting Started

These instructions will get you a copy of the project up.

Setup Database

The bot uses 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 🤗 .

⚠️ 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 to show your ❤️ .

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 ✅

• 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 if Love ❣️ the repo.

OS Requirements

Ubuntu

apt-get install poppler-utils libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 libffi-dev shared-mime-info

macOS

brew install libxml2 libxslt poppler cairo pango gdk-pixbuf libffi

Setup Virtual Environment

Create a virtual environment with the following command:

virtualenv venv
source venv/bin/activate

Bot Requirements

Run the following command to install the required packages:

pip install -r requirements.txt

Compile the translation files

Run the following command to compile all the translation files:

pybabel compile -D pdf_bot -d locale/

Setup Your Environment Variables

Copy the .env example file and edit the variables within the file:

cp .env.example .env

Running The Bot

You can then start the bot with the following command:

python bot.py

Follow me if Love ❣️ the repo.