nekomamoushi / home-finder

A snake bot that will find your new home !!!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Home Finder

This bot will scrape different apartment provider and find results matching your criteria. It has to be run periodically and if he finds new results, you will be notify.

Settings

First, you need to fill the settings with your criterias. You can use this sample.

Search

  • price:
    • MIN
    • MAX
  • surface:
    • MIN
    • MAX
  • rooms
  • bedrooms
  • cities

Notification

  • name: the notifier name
  • type: the type of notification
  • trigger: the trigger

Limitation

For now, there is only:

  • One provider: SELOGER
  • One notifier: IFTTT
    • One type: webhook

Setup

Before using this bot, you'll need an account on Dropbox and IFTTT

  • Dropbox

    • Create an acccount if you don't have on
    • create a directory named home-finder
    • put your settings.yml in this directory
    • export DROPBOX_TOKEN=your-dropbox-token
  • IFTTT

    • Create an acccount if you don't have on
    • Create a webhook service
    • update your settings.yml
    • export NOTIFIER_TOKEN=your-notifier-token

Usage

The entry point:

python src/roof_boot/cli.py

The first time you will run the bot, it will create a database of all the results. It will return the search url used for getting all the result (you can see the results on your favorite browser).

Then the second time you run it, it will notify you by mail if there are new results compare to the first search.

About

A snake bot that will find your new home !!!

License:MIT License


Languages

Language:Python 100.0%