Awesome

Bus Bot Data Manager

Data manager for Telegram bots based on serving Stops/Bus information for a public transportation system. Written mainly to use with the VigoBus-TelegramBot.

The data manager store all the persistent data the bot works with, mainly the Saved Stops that bot users can store, on MongoDB.

The communication between the bot backend and this data manager is through a REST API, serving GET, POST and DELETE endpoint methods. The API is powered by FastAPI and fully async.

Endpoints

• GET /status: get API status (healthcheck)
• GET /stops/{user_id}: get all the Stops saved by the given User
• POST /stops: insert or update a Saved Stop (stop data in body request)
• DELETE /stops/{user_id}/{stop_id}: remove the given Stop from the given User
• DELETE /stops/{user_id}: remove all the Stops from the given User

Changelog

• 0.2.2
  • Fix stop created field being removed on update
  • Refactor imports
• 0.2.1
  • Deprecate dotenv-settings-handler
  • Deprecate pybusent external library for data models
  • Freeze requirements package versions
  • Remove version setting
• 0.1.0
  • Add endpoint to delete all stops of a user
• 0.0.2
  • Renamed stopid, userid, name to stop_id, user_id, stop_name
• 0.0.1
  • Initial release
  • Functional GET, POST, DELETE methods connected with MongoDB

Requirements

• Python >= 3.6
• Requirements listed on requirements.txt
• A MongoDB server