ammaraskar / MilkshakeEventsBot

Syncs events from an events forum to a Google calendar and bumps them when the event is coming up.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MilkshakeEventsBot

Syncs events from an events forum to a Google calendar and bumps them when the event is coming up.

Looks for threads following the pattern MM/DD in a forum called events and turns them into calendar events. Storage is in a flat json file called db.json.

Setup

Setup requires creating a Google Apps Script that acts as a web-hook and creates Google Calendar events on your behalf. Yes seriously, this is easier than setting up oauth nonsense through Google Cloud and dealing with authentication nonsense.

Simply paste the contents of AppsScriptWebHook.js to a new script on https://script.google.com/ with the variables on the top changed and then deploy as a web app. The deployed URL and token will live in your secrets.

Running

  1. Set up a virtual env for the project with python -m venv venv

  2. Activate the virtual env with . venv/bin/activate

  3. Install dependencies pip install -r requirements.txt

  4. Copy secrets.example.json to secrets.json and fill with your secrets.

  5. Run python -m events_bot

Testing

  1. Follow above instructions to setup virtual environment.

  2. Install dev dependencies pip install -r requirements_dev.txt

  3. python -m pytest

Formatting

We format with black. This is checked on the CI.

About

Syncs events from an events forum to a Google calendar and bumps them when the event is coming up.

License:MIT License


Languages

Language:Python 96.3%Language:JavaScript 3.7%