ironriders/scoutbot
Archived
9
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A scouting aid bot
This repository has been archived on 2026-06-03. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
18 commits 1 branch 0 tags 50 KiB
  • Python 100%
Find a file
Exact
Jacob Erickson 86e6166d9a Add git command for update to readme
2023-03-23 13:14:14 -07:00
.gitignore Add tba and key template 2023-03-17 21:31:11 -07:00
.pylintrc Repo setup 2023-03-17 21:23:18 -07:00
key_.py Add key instructions to readme 2023-03-18 00:01:53 -07:00
main.py Fix dpr/ccwm naming for printout 2023-03-21 19:01:16 -07:00
poetry.lock Refactor slightly to use function calls as more descriptive 2023-03-21 17:05:03 -07:00
pyproject.toml Refactor slightly to use function calls as more descriptive 2023-03-21 17:05:03 -07:00
README.md Add git command for update to readme 2023-03-23 13:14:14 -07:00

README.md

ScoutBot

This is ScoutBot, it helps you run scouting data. It will do what you tell it to. Please add functionality so it gets used, otherwise it will be lonely.

Set up:

  • Python 3.9+
  • Poetry pip install poetry or pip3 install poetry depending on your environment
  • Get a read-key from TBA: https://www.thebluealliance.com/account
  • Clone Repo: git clone git@github.com:IronRiders/scoutbot.git
  • Install Environment: poetry install
  • Activate Environment: poetry shell
  • Follow instructions in key_.py as a template to use your key

To update:

  • Run git pull

To run:

  • Activate Environment: poetry shell
  • Run: python main.py

Notes:

This project used to use the TBA API (https://github.com/TBA-API/tba-api-client-python) built for python, but its codebase and useage was strange/out-of-date.

  • For exapmle the "If-None-Match" etag system was out of date and the code wouldn't recognize things already cached. Instead the codebase seemed to be using the phrase "If-Modified-Since" which isn't recognized by the API.
  • In addition there was a lot of things happening behind the scene with typing the responses which made useage confusing. Moving to requests allows better control and standard json deserialization to dictionaries/lists which are more intuitive to work with.