PromoBot

Promobot is a customizable web scraper made with some of the most used python libraries such as Requests, Selenium, and BeautifulSoup. This solution monitors websites by searching keywords occurrences and reporting to a Telegram chatbot.

The customization is the main resource which is the algorithm able to use any URL once you say the HTML tags where it’ll look to the keywords and get the link to share in Telegram.

The default customizations are classified in the country/region list (BR, CA, etc) and you can find them at config/promobot.yml.

Requirements

• Docker>=19.03.5
• Docker-compose>=1.24.1
• MongoDB==4.4.10
• Python 3.9

How to

Setup

There're two files to setup your bot, based on each docker orchestrator.

Orchestrator	YAML
Docker-compose	docker-compose.yml
Kubernetes	.kube/manifests/deployment.yml

The environment variables below are what you can customize on your end. The only required setups are TELEGRAM_CHAT_PASSWD and TELEGRAM_TOKEN.

DB_HOST=<mongodb-host>
TELEGRAM_TOKEN=<telegram-token>
TELEGRAM_CHAT_PASSWD=<chat-password>
KEYWORDS=<keyword1>;<keyword2>
DELAY=60
MUTED=false
RESET_TIME=72
TIMEOUT=30
TZ=America/Sao_Paulo

Install

$ make install

Package only install

$ [sudo] apt install python3.9 python-pip
$ pip install setuptools
$ ./setup.py install

Run locally

Docker

$ docker-compose up -d

Package

$ promobot --help
$ promobot
$ promobot --bot

Telegram chatbot

To be able to interact and get all the promotions found, you should start a chat with your chatbot, ask to register. After that, you can manage your promobot with the available commands.

Register your user to the chatbot

start <chat-password>

FYI: The <chat-password> must be the same value as the TELEGRAM_CHAT_PASSWD environment variable.

Commands to manage your promobot

Command	Description	Example
add	Add multiple keywords separeted by spaces.	add tv whey
config	Customize your times related to delay (in seconds), reset (in hours), and timeout (in seconds).	config delay=30 config reset=96 config timeout=15
del	Delete keywords by using their ID.	del 31
help	List all supported commands.	help
history	Get the latest promotions found for each added keyword.	history
info	General info about the bot.	info
kube	Manage your kubernetes if you chose it as the orchestrator.	kube info kube reload kube status
list	List all added keywords.	list
stats	Get the environment stats from where the promobot is running, such as CPUs, Memory, Swap, Disk, and Temperature.	stats
url	List all URLs which have been used by your promobot.	url
who	List the Telegram users who are registered in your chatbot.	who

Docker image

The image is hosted by Docker Hub promobot docker hub

$ docker pull leandro2r/promobot:latest