Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gfrn/bus-bot

Bot to track Oxfordshire bus arrivals
https://github.com/gfrn/bus-bot

Last synced: 26 days ago
JSON representation

Bot to track Oxfordshire bus arrivals

Host: GitHub
URL: https://github.com/gfrn/bus-bot
Owner: gfrn
License: apache-2.0
Created: 2024-12-22T11:29:20.000Z (about 1 month ago)
Default Branch: master
Last Pushed: 2024-12-29T17:48:58.000Z (about 1 month ago)
Last Synced: 2024-12-29T18:32:50.308Z (about 1 month ago)
Language: Python
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![CI](https://github.com/gfrn/bus-bot/actions/workflows/ci.yml/badge.svg)](https://github.com/gfrn/bus-bot/actions/workflows/ci.yml)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# Bus Bot

Slack bot for obtaining Oxfordshire bus information

## Configuration

- *SQL_DATABASE_URL* - SQL database URL. For example: `postgresql+psycopg://bus_bot_admin:[email protected]:5432/bus_bot`

- *SLACK_BOT_TOKEN* - Slack bot token

- *SLACK_APP_TOKEN* - Slack app token

- *ATCO_PREFIX* - ATCO prefix for the bus stops you want to monitor. Default is 340 (Oxfordshire)

## Running

- Start database with `podman-compose -f docker-compose.yml up`

- Set environment variables

- Run bot with `python3 -m bus_bot`

## Usage (user)

- Get your ATCO code from https://oxontime.com/home by clicking a bus stop, and copying the SMS code (starts with `oxf`)

- Register a new alert with /register [bus stop] [bus line] [time]

## TODO

- [ ] Enable HTTP mode

- [ ] Add buttons to delete alerts (requires HTTP mode)

- [ ] Use modal for creating alerts (requires HTTP mode)

- [ ] Allow user to only trigger alerts on certain weekdays

- [x] Alert user if bus is not being tracked

- [x] Create script to parse ATCO/NAPTAN bus stop listing from CSV file

- [ ] Create tests