Python Flathunter-Helper

Setup

Virtual Environment (Optional)

To keep you python environment and site-packages clean, it is recommended to run the project in a virtual environment. Install virtualenv, create a venv and activate.

$ pip install virtualenv
$ virtualenv -p /usr/bin/python3.6 venv
$ source venv/bin/activate

Requirements

Install requirements from requirements.txt to run execute flathunter properly.

pip install -r requirements.txt

Usage

usage: flathunter.py [-h] [--config CONFIG]

Searches for flats on Immobilienscout24.de and wg-gesucht.de and sends results
to Telegram User

optional arguments:
  -h, --help            show this help message and exit
  --config CONFIG, -c CONFIG
                        Config file to use. If not set, try to use
                        '~git-clone-dir/config.yaml'

Configuration

Bot registration

A new bot can registered with the telegram chat with the BotFather.

Chat-Ids

To get the chat id, the REST-Api of telegram can be used to fetch the received messages of the Bot.

$ curl https://api.telegram.org/bot[BOT-TOKEN]/getUpdates

Google API

To use the distance calculation feature a Google API-Key is needed.

Contributers

• @NodyHub
• Bene
• @Cugu