yawgbot 0.0.7

yawgbot - yet another wg bot

yawgbot

Yet Another WG helper bot. WG stands for Wohngemeinschaft, a German word that refers to a living arrangement in which several tenants share an apartment. It is aimed to automate the extremely complex and time-consuming task of finding a room or an apartment to rent. Initially it was only working for wg-gesucht.de, now it's a plugin-based system ready to be extended for every platform to find accommodation.

From a technical standpoint yawgbot is a simple tool that runs different plugins. A plugin either scrapes websites using requests and beautifulsoup4 or uses APIs (both public and undocumented) both to search for listings and to contact landlords. It uses a SQLite database to save contacted ads and to perform fewer requests to platforms. It also comes with a simple web UI to track your progress and gather your findings across different platforms.
The database is stored:

• on GNU/Linux at ~/.local/share/yawgbot/yawgbot.sqlite
• on Windows at %USERPROFILE%\AppData\Local\rcastellotti\yawgbot\yawgbot.sqlite
• on macOS at ~/Library/Application Support/yawgbot/yawgbot.sqlite

running manually

To run the bot manually:

• install the package with pip3 install yawgbot (a virtual environment is suggested)
• configure .config.myl, stored
  • on GNU/Linux at ~/.config/yawgbot/config.yml
  • on Windows at %USERPROFILE%\AppData\Local\rcastellotti\yawgbot\config.yml
  • on macOS at ~/Library/Preferences/yawgbot/config.yml
• create a new file named bot.py with the following content and run it:

from yawgbot import Bot
import logging

logging.basicConfig(level=logging.INFO)
bot = Bot(platforms=["wg-gesucht"])
bot.run()

running periodically with celery

Running in background at time intervals is achieved using Celery to schedule tasks. It is configured to use SQLite as both backend and broker, to know more read the docs. The file run_yawgbot.py, for example, runs the bot each 5 minutes, to use it:

• run celery -A run_yawgbot.celery worker --loglevel=INFO to run the worker
• run celery -A run_yawgbot.celery beat to schedule the bot

web UI

To start the web UI simply run yawgbot-web

plugins

creating a plugin

Extending yawgbot is a pretty straightforward process. A plugin is a simple module extending the PluginBase class, an example is wg-gesucht.py, supported plugins can be used just by instantiating Bot with the platforms argument. Custom plugins can be registered using the Bot.register_plugin() method.
To start creating a template you can use this boilerplate code:

from yawgbot.pluginBase import PluginBase


class YawgbotPlugin(PluginBase):
    def __init__(self):
        pass

    def get_ads(self, url):
        pass

    def parse_ad(self, ad):
        pass

    def contact_ad(self, slug):
        pass

    def run(self):
        pass

If you develop a plugin, consider creating a PR, I will be more than happy to work with you to make it an official plugin and ship it with yawgbot.

Each plugin should load configuration values using the static Bot.config() method.
To better understand plugins you can read the code in src/yawgbot/plugins.

wg-gesucht

config

wg-gesucht:
  username: ""
  password: ""
  message_template: ""
  base_url: ""

When configuring for use go on https://wg-gesucht.de and copy the url you are using to look for accommodation, then replace the last number with {} in order to be able to search across multiple pages, for example, if looking for apartments in Munich: base url is https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Munchen.90.1.1.1.html , replace the last 1 as follows: https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Munchen.90.1.1.{}.html