You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Jae Lo Presti 29cb2c48fc
README: update roadmap
1 week ago
.dockerignore CI: add Dockerfile 1 week ago
.gitignore meta: add ignore files 1 week ago
Dockerfile CI: add Dockerfile 1 week ago
LICENSE meta: add LICENSE & README file 1 week ago
README.md README: update roadmap 1 week ago
main.py main: working monitor 1 week ago
requirements.txt requirements: remove redis and add markdown 1 week ago

README.md

HSL Matrix Notifier

Sponsored

A simple bot program made to notify Matrix room(s) of HSL disruptions.

Running

You can easily use the program by following those steps:

git clone https://git.jae.fi/jae/hsl-matrix-notifier.git
vim docker-compose.yml

And in the docker-compose.yml file:

version: 3.9

services:
  hslcheck:
    build: ./hsl-matrix-notifier/
    environment:
      - MATRIX_TOKEN=supersecret
      - MATRIX_HOMESERVER=matrix.server.tld
      - HSL_NOTIFICATION_LANGUAGE=fi

And then do docker compose up -d and you have now a working bot.
It will query the API every 12 hours.

Note: it is recommended to use a .env file instead of putting everything in the docker-compose.yml file.

Dev setup

Dev setup:

git clone https://git.jae.fi/jae/hsl-matrix-notifier.git
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

All set (don't forget to set your env variables with Matrix homeserver & token)!

Roadmap

Roadmap of the project:

  • Only new events shown (RSS-feed style)
  • Per-room language
  • More customizable transport methods (select from bus, train, metro, tram)
  • Maubot plugin version
  • Hemppa plugin version