src package

Submodules

src.app module

class src.app.Notification(data, expire_time, clients)

Bases: object

Parameters:

• data (dict)

• expire_time (float)

• clients (list[str])

class src.app.TestingInfo(year, event_key, infile)

Bases: object

Parameters:

• year (str)

• event_key (str)

• infile (Path)

apply(initial_config)

Configues the app config data in memory to the testing info input

src.app.append_lines()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: [‘data’]

Appends a series of csv lines to the input data based off of the file sent via request.files

Complies with the restrict append level.

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.append_lines_nofile(lines_to_write, sending=False)

Appends lines_to_write to the input csv and reprocesses the data.

This will emit a notification if restrict append level is 1

Parameters:

• lines_to_write (list[str])

• sending (bool)

Return type:

None

src.app.apply_change(idx)

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

For restrict append level 2: applies the idx’th queued append

Parameters:

idx (int)

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]] | tuple[~typing.Literal[‘Invalid request’], ~typing.Literal[400]]

src.app.auto_scout_simple()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns the simple auton scounting html page

Return type:

str

src.app.auton_scout()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns the html page for auton scouting

Return type:

str

src.app.calc_team_score()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Calculates the aggregate score based on the OPRs of the three teams

Return type:

Response

src.app.changes()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Renders page listing changes to apply for restrict append level 2

Return type:

str

src.app.clear_datain()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

deletes the input data spreadsheet

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.clear_db()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

deletes the output database

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.compile_scouting_dashboard(url)

Uses jinja templating to create dashboard jsons for provisioning that cast all of the number fields to numbers

Parameters:

url (str)

Return type:

None

src.app.consume_tba_webhook()

Schema

Access: OPEN, UrlParams: [], Headers: [‘X-TBA-HMAC’], Body Keys: [‘message_type’], Files: []

Handles tba webhook authentication and resolution

Return type:

tuple[Literal[‘’], ~typing.Literal[401]] | tuple[~typing.Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.create_account()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

page allowing for the creation of new accounts

Return type:

tuple[Literal[‘Account created’], ~typing.Literal[200]] | str | tuple[~typing.Literal[‘Error: restricted’], ~typing.Literal[403]]

src.app.create_login()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘un’, ‘pwd’, ‘isadmin’], Files: []

Creates a new login with the specified parameters

Return type:

tuple[Literal[‘Success’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.delete_account()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘uid’], Files: []

Allows the user to delete users

Return type:

tuple[Literal[‘Account deleted.’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Deletion prohibited’], ~typing.Literal[403]]

src.app.delete_change(idx)

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

For restrict append level 2: drops the idx’th queued append

Parameters:

idx (int)

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Invalid request’], ~typing.Literal[400]]

src.app.delete_file()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘filepath’], Files: []

Handles deleting files for the file explorer

Return type:

tuple[Literal[‘Not allowed in local testing’], ~typing.Literal[401]] | tuple[~typing.Literal[‘Success’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Error, path does not exist’], ~typing.Literal[400]]

src.app.delete_lines()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘sending’], Body Keys: [‘lines’, ‘si’, ‘mn’], Files: []

For restrict append level 1: deletes the already applied append cooresponding to the input json’s lines field using rm_row_hash()

Return type:

tuple[Literal[‘’], ~typing.Literal[200]]

src.app.dload()

Schema

Access: LOGIN, UrlParams: [], Headers: [‘file’], Body Keys: [], Files: []

Sends a stream using the stream helper for the requested file to download it

Return type:

tuple[Literal[‘File not found.’], ~typing.Literal[404]] | ~werkzeug.wrappers.response.Response

async src.app.do_data_processing()

Runs the process and postprocess routines

Return type:

None

src.app.download_folder()

Schema

Access: LOGIN, UrlParams: [], Headers: [‘path’], Body Keys: [], Files: []

Download a data folder, such as the notes or photos directories, as a zip

Return type:

Response

src.app.edit_app_conf_page()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a monaco page for editing the app configuration

Return type:

str

src.app.edit_file()

Schema

Access: ADMIN, UrlParams: [‘filepath’], Headers: [], Body Keys: [], Files: []

Returns a monaco page for editing the file specified by the filepath urlparam

Return type:

str | tuple[Literal[‘Error, path does not exist’], ~typing.Literal[400]]

src.app.edit_yaml()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Renders the editing template for web editing the field-config.yaml file

Return type:

str

src.app.ensure_untracked_dirs()

Ensures that the upload and output directories exist.

It is wrapped in a function because these directories can change at runtime.

Return type:

None

src.app.events_from_team()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns a list of events from the inputted team

Return type:

Response

src.app.explore()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a web file tree for browsing files

Return type:

str

src.app.get_app_config()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns the app configuration for the editor at /edit-app-conf to read

Return type:

Response

src.app.get_current_event()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns the event key currently loaded into the app

Return type:

str | Any

src.app.get_fa_icon(name)

Gets the font-awesome icon cooresponding to the file extension

Parameters:

name (str)

Return type:

str

src.app.get_log()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘log’], Body Keys: [], Files: []

Returns the contents of the specified log

Return type:

tuple[str, Literal[200]] | tuple[str, ~typing.Literal[400]]

src.app.get_note_tables()

Schema

Access: OPEN, UrlParams: [‘team’], Headers: [], Body Keys: [], Files: []

returns a tabulated dictionary of each scouters’ notes for a team

Return type:

Response

src.app.get_notes()

Schema

Access: LOGIN, UrlParams: [], Headers: [‘match’, ‘team’, ‘pre’], Body Keys: [], Files: []

returns the text content of the specified note

Return type:

str | tuple[Literal[‘File not found’], ~typing.Literal[400]]

src.app.get_picklist()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a dictionary representing the picklist for the specified user

Return type:

Response | tuple[Literal[‘File not found’], ~typing.Literal[400]]

src.app.get_tba_key()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns the current TBA api key and whether or not it is good

Return type:

Response

src.app.get_team_indicies()

Schema

Access: OPEN, UrlParams: [‘team’], Headers: [], Body Keys: [], Files: []

gets the list of indicies (a range) of the valid photos for a team, ie. [0, 1] for a team with 2 photos

Return type:

Response | tuple[str, Literal[500]] | tuple[~typing.Literal[‘Error: invalid request’], ~typing.Literal[400]]

src.app.get_team_pics()

Schema

Access: OPEN, UrlParams: [‘team’], Headers: [], Body Keys: [], Files: []

Return the uploaded picture cooresponding to the team given in the ?team urlparam

Return type:

Response | tuple[Literal[‘Error, team picture not found’], ~typing.Literal[400]] | tuple[str, ~typing.Literal[500]] | tuple[~typing.Literal[‘Error: invalid request’], ~typing.Literal[400]]

src.app.get_user_display()

Schema

Access: LOGIN, UrlParams: [], Headers: [‘id’], Body Keys: [], Files: []

Returns the pill display for a user

Return type:

str

src.app.handle_401(e)

Handles a 401 (not logged in) error

Parameters:

e (Exception)

Return type:

str | tuple[str, Literal[401]]

src.app.handle_403(e)

Handles a 403 (page restricted) error

Parameters:

e (Exception)

Return type:

str | tuple[Literal[‘Error: restricted’], ~typing.Literal[403]]

src.app.handle_404(e)

Custom 404 (page not found) handler

Parameters:

e (Exception)

Return type:

str | tuple[Literal[‘Error: page not found’], ~typing.Literal[404]]

src.app.handle_exception(e)

Dampens the app’s explosion

Parameters:

e (Exception)

Return type:

str | tuple[str, Literal[500]]

src.app.handle_mesh_line(message)

This function is a consumer for a meshtastic message (line of csv) and will append it to the csv much like append_lines()

Parameters:

message (str)

Return type:

None

src.app.handle_tba_webhook(notification_json)

Consumes a tba webhook push request and performes actions based on message_type.

• match_score: runs peridoc fetch

• schedule_updated: loads event data

• ping: sends notification

• broadcast: sends notification

• verification: sends notification

Parameters:

notification_json (dict)

Return type:

None

src.app.health()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Health check, primarily so that QRScout can know its url is correct

Return type:

tuple[Literal[‘No event data’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Sentinel is watching’], ~typing.Literal[200]]

src.app.jobs()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a dictionary of active Events running from the processor

Return type:

Response

src.app.load_event_data()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘event’], Body Keys: [], Files: []

loads in the data for the specified event

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]] | tuple[~typing.Literal[‘Invalid event key’], ~typing.Literal[400]]

src.app.log_request()

logs the method and path of the request

Return type:

None

src.app.login()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Sends login page and validates login un/pw

Return type:

tuple[Literal[‘Login Successful’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Invalid Credentials’], ~typing.Literal[401]] | str

src.app.login_override()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [‘key’], Files: []

Handles the login override on the login screen

Return type:

tuple[Literal[‘Login Override Successful’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Invalid Credentials’], ~typing.Literal[401]]

src.app.logout()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Logs out the user

Return type:

Response

src.app.main()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Renders homepage html template, passes the public key to the client to bind the service worker

Return type:

str

src.app.make_comment()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Handles making a comment on a picklist team

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[~typing.Literal[‘File not found’], ~typing.Literal[404]]

src.app.manage_accounts()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

page for viewing and deleting accounts

Return type:

str

src.app.matches_in_comp()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns the list of matches in the currently loaded competition

Return type:

Response

src.app.mesh_listen()

Binds handle_mesh_line() to the meshtastic port (listens for meshages)

Return type:

None

src.app.multi_view()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns an html page for comparing teams with grafana iframes

Return type:

str

src.app.n3()

Schema

Access: OPEN, UrlParams: [‘mkey’], Headers: [], Body Keys: [], Files: []

Returns the next app.config["NEXT_N_MATCHES_NUMBER"] (currently 3, hence the name) matches after ?mkey that contain ?team

where ?x is the url parameter named x

Return type:

Response

src.app.notify_q()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘X-Cid’], Body Keys: [], Files: []

pop the queue of notifications for frontend to consume and notify the user

Return type:

Response | tuple[Literal[‘Error, invalid cid’], ~typing.Literal[400]] | tuple[~typing.Literal[‘No notifications in queue’], ~typing.Literal[204]]

src.app.percent()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Rest passthrough for other-metrics.json, named percent because its current data is the percentage of teams scouted.

Return type:

Response | str

src.app.picklist()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a page to make a picklist

Return type:

str

src.app.pit_scout()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns the pit scouting html page

Return type:

str

src.app.read_log()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a readonly monaco page for viewing the specified log

Return type:

str

src.app.reload_js()

Updates the copy of the other-metrics.json file in memory (used for percent() endpoint) to use the newest file

Return type:

None

src.app.rename_file()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘old’, ‘new’], Files: []

Handles renaming of files for the file explorer

Return type:

tuple[Literal[‘Not allowed in local testing’], ~typing.Literal[401]] | tuple[~typing.Literal[‘Success’], ~typing.Literal[200]] | tuple[~typing.Literal[‘Error, path does not exist’], ~typing.Literal[400]]

src.app.render_template_style(template, **context)

Renders the input template with the given context and also the accent and text colors of the app

Parameters:

• template (str | Template | list[str | Template])

• context (Any)

Return type:

str

src.app.reprocess()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Reprocesses the data with no additional inputs; for testing or manual csv changes

Return type:

tuple[Literal[‘Data reloaded.’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.reset_dash()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

recompiles the grafana dashboards based on the templates

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.restart()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Kills the app for restarting with always-restart in docker compose

Return type:

NoReturn

src.app.rm_row_hash(hashes)

Deletes rows of data from the input csv by matching their hashes with the ones provided and then reprocesses the data

Parameters:

hashes (list[str])

Return type:

None

src.app.run_async_task(coro)

Runs a coroutine as a sepearte asyncronous thread

Return type:

None

src.app.run_process()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘process’], Files: []

runs the process specified by process in the request body.

• load_event_data: loads event data

• perform_periodic_calls: performs periodic calls

• do_data_processing: performs data processing

Return type:

tuple[Literal[‘Error, invalid process requested’], ~typing.Literal[400]] | tuple[~typing.Literal[‘Process requested’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.save_app_config()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Consumes an app configuration json, saves it, and applies it

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.save_auto(filestorage, match)

saves a picture generated from auton scouting

Parameters:

match (str)

Return type:

None

src.app.save_auto_simple()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Handles the submission of the simple auton scouting form

Return type:

tuple[Literal[‘Success’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.save_file()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘code’, ‘path’], Files: []

Saves the file

Return type:

Response

src.app.save_notes()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [‘team’, ‘data’, ‘match’, ‘pre’], Files: []

saves scouter notes for a team

Return type:

Response

src.app.save_photo(filestorage, team)

saves the given filestorage to PHOTO_STORAGE/{team}.ext where ext is the extension of filestorage

Parameters:

team (str)

Return type:

None

src.app.save_picklist()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Handles saving a picklist

Return type:

tuple[Literal[‘Success’], ~typing.Literal[200]]

src.app.save_pit()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Handles the submission of the pit scouting form

Return type:

tuple[Literal[‘Success’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.save_yaml()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘code’], Files: []

A file consumer that saves the field-config.yaml file during web editing

Return type:

Response

src.app.send_change_notification(lines=None)

Sends a notification.

If ‘lines’ is None, this will send a notification letting the user know that new changes are avaliable (restrict append level is 2) with a link to changes().

If ‘lines’ is not None, restrict append level is assumed to be 1 and a new notification that’s body has lines and a link to remove lines from the input data will be sent.

Parameters:

lines (str | None)

Return type:

None

src.app.send_generic_notification(data)

sends a notification with title/body/etc. specified by data. The icon is added by this function.

Parameters:

data (dict)

Return type:

None

src.app.send_sw()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Passthrough for the service worker so that the client can fetch it

Return type:

Response

src.app.set_creds()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘un’, ‘pwd’, ‘isadmin’], Files: []

Add or overwrite a login

Return type:

tuple[Literal[‘Success’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.set_tba_key()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘key’], Files: []

verifies the inputted api key sent via json[“key”], applies it and writes it to tba.txt, and reprocesses data

Return type:

tuple[Literal[‘Bad TBA key’], ~typing.Literal[400]] | tuple[~typing.Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.set_tba_whook_key()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [‘key’], Files: []

Sets the tba webhook secret based of of the one specified in the TBA webhook registration on the account page

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.start_loop(loop)

This function starts the main thread for running events

Parameters:

loop (AbstractEventLoop)

Return type:

None

src.app.take_notes()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

returns the html page for note taking

Return type:

str

src.app.teams_in_match()

Schema

Access: LOGIN, UrlParams: [‘mkey’], Headers: [], Body Keys: [], Files: []

returns a list of the teams in the specified match

Return type:

Response | tuple[Literal[‘Error, match not in data’], ~typing.Literal[404]]

src.app.test_mesh()

Schema

Access: ADMIN, UrlParams: [‘m’], Headers: [], Body Keys: [], Files: []

Debug endpoint to test the meshtastic listener without a mesh radio

Return type:

str

src.app.test_notification()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Sends a test notification to the server

Return type:

tuple[Literal[‘Sent’], ~typing.Literal[200]]

src.app.test_tba_key()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘key’], Body Keys: [], Files: []

tests whether or not the given TBA api key is valid, returning a string ‘true’ for good and ‘false’ for bad

Return type:

tuple[Literal[‘true’], ~typing.Literal[200]] | tuple[~typing.Literal[‘false’], ~typing.Literal[200]]

src.app.update_like()

Schema

Access: LOGIN, UrlParams: [], Headers: [‘list’, ‘pick’, ‘team’, ‘like’], Body Keys: [], Files: []

Handles liking/disliking a picklist team

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[~typing.Literal[‘File not found’], ~typing.Literal[400]]

src.app.upload_auto()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘mkey’], Body Keys: [], Files: [‘photo’]

Saves a picture generated by the auton scouting

Return type:

tuple[Literal[‘Saved!’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]] | None

src.app.upload_file()

Schema

Access: ADMIN, UrlParams: [], Headers: [], Body Keys: [], Files: [‘data’]

Overrides the current input data with an uploaded file from the frontend and reprocesses the data

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.upload_folder()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘folderPath’], Body Keys: [], Files: [‘data’]

Upload a zipped folder containing notes, photos, etc.

Note

Zipped folders may be too large to upload when the server is running on cloudflare, etc.

Return type:

tuple[Literal[‘Error, no selected file’], ~typing.Literal[400]] | tuple[~typing.Literal[‘Invalid Zip file’], ~typing.Literal[400]] | tuple[~typing.Literal[‘File uploaded successfully’], ~typing.Literal[200]]

src.app.upload_other_files()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘name’], Body Keys: [], Files: [‘data’]

Handles file uploading for dataout files such as pit scouting data

Return type:

tuple[Literal[‘’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]]

src.app.upload_photo()

Schema

Access: ADMIN, UrlParams: [], Headers: [‘team’], Body Keys: [], Files: [‘photo’]

Save a photo for the cooresponding team

Return type:

tuple[Literal[‘Saved!’], ~typing.Literal[200]] | tuple[str, ~typing.Literal[500]] | None

src.app.view_file()

Schema

Access: ADMIN, UrlParams: [‘filepath’], Headers: [], Body Keys: [], Files: []

Returns a stream of the file specified by ?filepath, primarily for viewing images

Return type:

Response | tuple[Literal[‘Error, path does not exist’], ~typing.Literal[400]]

src.app.view_picklist()

Schema

Access: LOGIN, UrlParams: [‘list’], Headers: [], Body Keys: [], Files: []

Returns an html page to view a picklist and comment/rate teams

Return type:

str

src.app.view_picklists()

Schema

Access: LOGIN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns an html page displaying all of the submitted picklists

Return type:

str

src.app.whoami()

Schema

Access: OPEN, UrlParams: [], Headers: [], Body Keys: [], Files: []

Returns a dictionary specifying the logged_in status of the user, and un/id/isadmin if applicable

Return type:

Response

src.apputils module

class src.apputils.PathUtils

Bases: object

class FileSet(origin_path)

Bases: object

Parameters:

origin_path (Path)

relative_to_origin(*paths)

Parameters:

paths (str | Path)

search(search_pattern, *subpath)

Parameters:

search_pattern (str)

Return type:

Iterator[Path]

set_origin(origin_path)

Parameters:

origin_path (Path)

file_set = <src.apputils.PathUtils.FileSet object>

grafana_dashboard_posix_root = '/var/lib/grafana/dashboards'

relative_to_origin(*paths)

Parameters:

paths (str | Path)

search(search_pattern, *subpath)

Parameters:

search_pattern (str)

Return type:

Iterator[Path]

class src.apputils.TBADataDynamic(ranks={}, copr={}, curr_oprs={})

Bases: object

class src.apputils.TBADataStatic(teams=[], team_info={}, schedule={}, opr={})

Bases: object

src.apputils.can_cast(x, _type)

Parameters:

• x (Any)

• _type (type)

Return type:

bool

src.apputils.change_un_pwd_admin(current_secret_key, newun, newpwd)

updates the username and password

Parameters:

• current_secret_key (str)

• newun (str)

• newpwd (str)

Return type:

None

src.apputils.change_un_pwd_viewer(current_secret_key, newun, newpwd)

updates the username and password

Parameters:

• current_secret_key (str)

• newun (str)

• newpwd (str)

Return type:

None

src.apputils.clear_pictures()

Return type:

None

src.apputils.data_in_exists()

checks whether the data_in file exists for app based on its config

Return type:

bool

src.apputils.exception_format(e)

Gets the stack frame where the exception ACTUALLY occured (deepest frame not in a dependecy)

Parameters:

e (Exception)

Return type:

str

src.apputils.generate_ssl_sign()

useless?

Return type:

None

src.apputils.get_event_team_oprs(event_key, api_key)

Return type:

dict[Any, Any] | Any

src.apputils.get_num_team_pics(team, photo_dir)

Return type:

int

src.apputils.get_tasks_snapshot(loop=None)

Returns a snapshot of all asyncio tasks without blocking. Can be called from synchronous code.

Return type:

dict

src.apputils.get_tba_coprs(event_key, api_key, config_data)

Return type:

dict

src.apputils.get_tba_events(key, year, team)

Return type:

list[dict]

src.apputils.get_tba_images(api_key, year, teams)

Return type:

None

src.apputils.get_tba_opr(event_key, api_key, year, teams)

returns a dictionary of each team to their cooresponding opr at their last competition

Return type:

dict

src.apputils.get_tba_ranks(event_key, api_key, teams)

returns a dictionary mapping each team to a tuple of their rank and rps

Return type:

dict

src.apputils.has_internet()

pings google for 10 seconds and returns whether it’s okay

Return type:

bool

src.apputils.invert_jeson(jeson)

Parameters:

jeson (dict)

Return type:

dict

src.apputils.is_iterable(x)

Parameters:

x (Any)

Return type:

bool

src.apputils.line_str_hash(row)

Hashes a line of text with sha256

Parameters:

row (str)

Return type:

str

src.apputils.load_tba_data_dynamic(event_key, api_key, config_data, teams_list)

Return type:

TBADataDynamic

src.apputils.load_tba_data_static(event_key, api_key, year, last_opr_disabled)

Loads up the teams and schedule for event_key and returns a tuple (teams, schedule)

Return type:

TBADataStatic

src.apputils.read_secrets()

Reads the different secrets of the repo: admin creds, flask secret key, and tba auth key in that order

Return type:

tuple[str, str, str]

src.apputils.safer_replace(src, dest)

os.replace dies sometimes

Return type:

None

src.apputils.set_auth_key(key)

sets the tba key to key

Parameters:

key (str)

Return type:

None

src.apputils.set_tba_whook_key(hmac)

Parameters:

hmac (str)

Return type:

None

src.apputils.stream(file)

Return a stream which reads a file in chunks; used for downloading in case files get big

Return type:

Generator[bytes, Any, None]

src.apputils.tba_health()

pings tba for 10 seconds and returns whether it’s okay

Return type:

bool

src.apputils.test_tba_key(key)

pings tba/api/v3/status with the key given to see if the key is good

Parameters:

key (str)

Return type:

bool

src.apputils.yaml_check_schema_raise_errors(yamldata)

Return type:

None

src.auth module

class src.auth.CreateAccount(*args, **kwargs)

Bases: FlaskForm

Form used on the login page to log in

password = <UnboundField(PasswordField, ('Password',), {'validators': [<wtforms.validators.DataRequired object>], 'render_kw': {'placeholder': 'Enter password...'}})>

submit = <UnboundField(SubmitField, ('Create Account',), {})>

username = <UnboundField(StringField, ('Username',), {'validators': [<wtforms.validators.DataRequired object>], 'render_kw': {'placeholder': "Enter username (ie. 'Frodo Baggins')..."}})>

class src.auth.LoginForm(*args, **kwargs)

Bases: FlaskForm

Form used on the login page to log in

password = <UnboundField(PasswordField, ('Password',), {'validators': [<wtforms.validators.DataRequired object>]})>

submit = <UnboundField(SubmitField, ('Log in',), {})>

username = <UnboundField(StringField, ('Username',), {'validators': [<wtforms.validators.DataRequired object>]})>

src.auth.add_user_to_db(username, password, is_admin=False)

Return type:

None

src.auth.delete_user(my_uid, uid)

Return type:

bool

src.auth.display_user(id)

Parameters:

id (str)

Return type:

str

src.auth.generate_login_db(un, pwd)

Return type:

None

src.auth.generate_random_color(isadmin)

Parameters:

isadmin (bool)

Return type:

str

src.auth.get_can_delete_user(user_uid, uid_to_delete)

Return type:

bool

src.auth.get_password_is_admin(password)

Return type:

Any | bool

src.auth.get_table_exists()

Return type:

bool

src.auth.get_user_from_db(uid)

Return type:

人 | None

src.auth.get_user_from_db_unpw(un, pwd)

Return type:

人 | None

src.auth.get_user_is_admin(user)

Parameters:

user (UserMixin)

src.auth.get_users()

Return type:

list[tuple]

src.auth.init_loginm_app(app)

Registers a login manager for admin to the flask app

Parameters:

app (Flask)

Return type:

None

src.auth.override_get_admin()

Return type:

人 | None

src.auth.require_admin(f)

Ensures that the user is logged into an admin account on the modifiee endpoint

src.auth.text_slug(text)

Parameters:

text (str)

Return type:

str

class src.auth.人(id, un, pwd, isadmin, color)

Bases: UserMixin

A user

src.endpoint_schemas module

class src.endpoint_schemas.EndpointAccess(*values)

Bases: Enum

ADMIN = 2

LOGIN = 1

OPEN = 0

class src.endpoint_schemas.EndpointSchema(access, check_json=False, headers=[], args=[], json=[], files=[])

Bases: object

Specifies the access mode and args/headers/body keys required for the endpoint, checking them via flask routing wrappers

Parameters:

• access (EndpointAccess)

• check_json (bool)

• headers (list[str])

• args (list[str])

• json (list[str])

• files (list[str])

static wrap_flask_routing(flask_route_method)

Wraps a flask routing wrappers (app.get/post/etc) to automatically apply the verify_schema wrapper to wrapped functions

src.endpoint_schemas.wrap_flask_routing(flask_route_method)

Wraps a flask routing wrappers (app.get/post/etc) to automatically apply the verify_schema wrapper to wrapped functions

Module contents

Subpackages

• src.lib package
  • Submodules
  • src.lib.bs module
    • BeakscriptInterpretError
      • BeakscriptInterpretError.curr_eq_name
      • BeakscriptInterpretError.curr_equation
    • TOKENS
      • TOKENS.BINARY_OP
      • TOKENS.HEADER
      • TOKENS.HEADER_COND
      • TOKENS.LIST_LITERAL
      • TOKENS.LITERAL
      • TOKENS.PAREN
      • TOKENS.UNARY_OP
    • Token
    • UnpackList
    • attempt_slice()
    • df_safe_and()
    • df_safe_in()
    • df_safe_or()
    • eval_beakscript()
    • evaluate_binary_operator()
    • evaluate_unary_operator()
    • float_or_int()
    • floatize_if_str()
    • get_last_nowhitespace()
    • parse_equation()
    • preproc_implicit_ops()
    • rpn()
    • solve_rpn()
    • strfloatize_if_bool()
    • strize_if_float()
  • src.lib.data_config module
    • GrafanaDataPreset
      • GrafanaDataPreset.MATCH()
      • GrafanaDataPreset.NONE()
      • GrafanaDataPreset.PREMATCH()
      • GrafanaDataPreset.PREMATCH_SCORE()
      • GrafanaDataPreset.TEAM()
    • get_svd_headers()
    • lex_config()
    • read_config()
  • src.lib.data_main module
    • DataField
      • DataField.average()
      • DataField.calc_map
      • DataField.filter()
      • DataField.max()
      • DataField.objectify()
    • Event
      • Event.current_event
      • Event.current_event_len
      • Event.current_handle_index_progress
      • Event.event_progress
      • Event.fire()
      • Event.get_event_progress()
      • Event.global_lock
      • Event.task
    • MatchStruct
      • MatchStruct.add_team_data()
      • MatchStruct.output_dict()
    • ObjectHolder
    • Processor
      • Processor.NUM_TABLES
      • Processor.clear_database()
      • Processor.delete_match_scouter()
      • Processor.get_team_pred_score()
      • Processor.load_event_data()
      • Processor.mad_filter()
      • Processor.perform_periodic_calls()
      • Processor.proccess_data()
      • Processor.round_sigfigs()
    • TeamStruct
      • TeamStruct.extend_data()
      • TeamStruct.output_dict()
  • src.lib.mesh module
    • get_is_meshed()
    • main()
    • on_receive()
    • send_command()
    • send_mesh_test()
    • send_message()
  • Module contents
• src.tests package
  • Submodules
  • src.tests.apptest module
    • TestApp
      • TestApp.BASE_URL
      • TestApp.test_auton_scout()
      • TestApp.test_auton_simple()
      • TestApp.test_changes()
      • TestApp.test_edit_app_conf()
      • TestApp.test_edit_file()
      • TestApp.test_edit_yaml()
      • TestApp.test_explore()
      • TestApp.test_get_config()
      • TestApp.test_get_user()
      • TestApp.test_health()
      • TestApp.test_jobs()
      • TestApp.test_main()
      • TestApp.test_manage_accounts()
      • TestApp.test_multi_view()
      • TestApp.test_notifications()
      • TestApp.test_percent()
      • TestApp.test_pit()
      • TestApp.test_plist()
      • TestApp.test_processing()
      • TestApp.test_read_log()
      • TestApp.test_sw()
      • TestApp.test_vap()
      • TestApp.test_view_file()
      • TestApp.test_whoami()
    • assert_sqlite_equal()
    • assert_url_active()
    • get_rows()
    • get_schema()
    • get_tables()
  • src.tests.libtest module
    • TestBeakscript
      • TestBeakscript.test_binary_operators()
      • TestBeakscript.test_config_files_scheme()
      • TestBeakscript.test_header_sum()
      • TestBeakscript.test_operator_prec()
      • TestBeakscript.test_regex_header()
      • TestBeakscript.test_type_coercion_and_types()
      • TestBeakscript.test_unary_operators()
  • Module contents