Welcome to Olx-monitor 👋

scrapes Olx website, watching for user-defined keywords and notifies the user via Telegram

Install

Please read first Creating a Telegram bot with BotFather - telegram.org and Telegram Bot - how to get a group chat id? - Stackoverflow

Create a .env file with the following options:

TELEGRAM_BOT_TOKEN="<bot token:string>"
TELEGRAM_BOT_CHAT_ID=<chat id:int>

Then:

pipenv shell
pipenv install

Initial data

This app needs keywords to be registered in order to know what to look for.

You can save a file in the format below at <current working directory>/keywords-to-import.json or <home>/.olx-monitor/keywords-to-import.json:

[
	{
	    "keywords": [ "<any keyword>" ],
	    "state": "<olx brazilian state id>",
	    "state_region": "<olx brazilian state region>",
	    "region_subregion": "<olx brazilian subregion>",
	    "city": "<olx brazilian city",
	    "category": "<olx category>"
	}
]

This is a working example:

[
	{
	    "keywords": [ "switch", "psp", "metal gear" ],
	    "state": "mg",
	    "state_region": "regiao-de-uberlandia-e-uberaba",
	    "region_subregion": "triangulo-mineiro",
	    "city": "uberlandia",
	    "category": "videogames"
	}
]

Usage

pipenv run python runner.py

Schedule

Using the app continuous run mechanism

Start the app with:

pipenv run python runner.py --scheduled

The config key DELAY_BETWEEN_CRAWLS can be set in seconds to tune the delay between crawl runs. Set it in the config file or pass through environment variables.

Using crontab

Run:

crontab -e

Add to the end of the file:

*/15 * * * * cd <project directory> && /usr/bin/pipenv run python <project directory>/runner.py

*/15 * * * * equals every 15 minutes. Check Crontab Guru for a nice crontab editing experience.

Running with docker

A standard Dockerfile is provided. Below is an example on how to run with docker.

docker build . --tag olx-monitor
docker run -v <host path to keywords-to-import.json>:/opt/app/keywords-to-import.json -e TELEGRAM_BOT_TOKEN="<telegram token>" -e TELEGRAM_BOT_CHAT_ID=<telegram chat id> olx-monitor
docker update --restart=always <container> # optional

Troubleshooting

Add this to your PATH if pipenv is not found:

PYTHON_BIN_PATH="$(python3 -m site --user-base)/bin"
PATH="$PATH:$PYTHON_BIN_PATH"

libgcc_s.so.1 must be installed for pthread_cancel to work
Aborted

then

For Fedora

sudo yum install java-1.8.0-openjdk.i686

For debian-based

sudo apt install openjdk-8-jdk

Author

👤 Marcelo Paixão Resende

Website: https://br.linkedin.com/in/marcelopaixaoresende
Twitter: @marcelopaixaor
Github: @marcelothebuilder
LinkedIn: @marcelopaixaoresende

Show your support

Give a ⭐️ if this project helped you!

📝License

This project is GPL--3.0 licensed.

This README was generated with ❤️ by readme-md-generator

marcelothebuilder / olx-monitor