API Reference

The gamesheet_sdk package exposes Pythonic wrappers around the GameSheet platform. Complete API documentation for all modules, packages, and subpackages is generated automatically from source on every documentation build using sphinx-apidoc.

The package is organized into three pillars:

• common — Shared infrastructure (auth, config, session, browser, output, errors)

• admin — Admin dashboard domain modules and CLI

• teams — Teams dashboard CLI (domain modules forthcoming)

Module index

All Python modules are automatically discovered and documented. Click any module name to view its complete API documentation.

gamesheet_sdk	gamesheet_sdk — unofficial Python SDK for the GameSheet Inc.
gamesheet_sdk.common	Shared infrastructure for the GameSheet SDK.
gamesheet_sdk.common.auth	Authentication flows and token management for GameSheet.
gamesheet_sdk.common.browser	Reusable Playwright browser session for the JS-heavy WebUI path.
gamesheet_sdk.common.cli	Shared CLI utilities for GameSheet CLIs.
gamesheet_sdk.common.config	Configuration for an SDK session.
gamesheet_sdk.common.constants	SDK-wide constants and configuration values.
gamesheet_sdk.common.errors	Error message templates for the GameSheet SDK.
gamesheet_sdk.common.exceptions	Exceptions raised by gamesheet_sdk.
gamesheet_sdk.common.output	Multi-format rendering of tabular data for CLI workflows.
gamesheet_sdk.common.session	Reusable HTTP session for talking to the GameSheet WebUI.
gamesheet_sdk.common.shared	Shared utilities for domain modules.
gamesheet_sdk.admin	Admin dashboard SDK for GameSheet.
gamesheet_sdk.admin.associations	GameSheet associations: the top-level organizational unit of the platform.
gamesheet_sdk.admin.divisions	GameSheet divisions: organizational groupings within a season.
gamesheet_sdk.admin.games	GameSheet games: scheduled, completed, and bracket games within a season.
gamesheet_sdk.admin.ipad_keys	GameSheet iPad keys: Scoring Access Keys for season scoring via iPad app.
gamesheet_sdk.admin.leagues	GameSheet leagues: divisions within an association.
gamesheet_sdk.admin.referees	GameSheet referees: officials assigned to games within a season.
gamesheet_sdk.admin.roster	GameSheet roster: players and coaches within a season.
gamesheet_sdk.admin.seasons	GameSheet seasons: time periods within a league.
gamesheet_sdk.admin.teams	GameSheet teams: competing organizations within a season.
gamesheet_sdk.admin.cli	CLI for the GameSheet admin dashboard.
gamesheet_sdk.teams	Teams dashboard SDK for GameSheet.
gamesheet_sdk.teams.cli	CLI for the GameSheet teams dashboard.

Common infrastructure

Shared modules used by both admin and teams CLIs.

• gamesheet_sdk.common
  • gamesheet_sdk.common.auth
  • gamesheet_sdk.common.browser
  • gamesheet_sdk.common.cli
  • gamesheet_sdk.common.config
  • gamesheet_sdk.common.constants
  • gamesheet_sdk.common.errors
  • gamesheet_sdk.common.exceptions
  • gamesheet_sdk.common.output
  • gamesheet_sdk.common.session
  • gamesheet_sdk.common.shared
• gamesheet_sdk.common.browser
  • BrowserSession
• gamesheet_sdk.common.config
  • Config
• gamesheet_sdk.common.constants
• gamesheet_sdk.common.errors
• gamesheet_sdk.common.exceptions
  • GameSheetError
  • AuthenticationError
• gamesheet_sdk.common.output
  • render()
  • write_output()
• gamesheet_sdk.common.session
  • Session

Authentication package

Authentication flows, token management, and authenticated HTTP session.

• gamesheet_sdk.common.auth
  • AdminLoginFlow
  • AuthenticatedSession
  • BaseAuthenticatedSession
  • LoginFlow
  • extract_firebase_error()
  • load_access_token()
  • load_refresh_token()
  • login()
  • refresh_access_token()
  • resolve_email()
  • resolve_password()
  • save_tokens()
• gamesheet_sdk.common.auth.constants module
• gamesheet_sdk.common.auth.login module
  • login()
  • AdminLoginFlow
• gamesheet_sdk.common.auth.session module
  • BaseAuthenticatedSession
  • AuthenticatedSession
• gamesheet_sdk.common.auth.storage module
  • read_state_file()
  • lookup_local_storage()
  • load_local_storage_value()
  • read_state_or_empty()
  • origin_entry_for()
  • apply_local_storage_updates()
• gamesheet_sdk.common.auth.tokens module
  • load_access_token()
  • load_refresh_token()
  • build_token_updates()
  • save_tokens()
  • refresh_access_token()

Shared utilities

Shared utilities and helpers used across the SDK.

• gamesheet_sdk.common.shared
  • check_bff_response_status()
  • handle_response()
  • upload_image()
• gamesheet_sdk.common.shared.constants module
  • JSONAPI_CONTENT_TYPE
  • JSONAPI_HEADERS
• gamesheet_sdk.common.shared.gamesheet_http module
  • handle_response()
  • check_bff_response_status()
  • handle_season_scoped_response()
• gamesheet_sdk.common.shared.image_upload module
  • upload_image()

Common CLI infrastructure

Shared CLI framework used by both admin and teams CLIs.

• gamesheet_sdk.common.cli
  • ResourceGroup
  • confirm_destructive()
  • parse_columns_spec()
  • resolve_exit()
  • resolve_system_exit()
• gamesheet_sdk.common.cli.constants module
• gamesheet_sdk.common.cli.core module
  • ResourceGroup
  • confirm_destructive()
  • parse_columns_spec()
  • resolve_system_exit()
  • resolve_exit()

Admin domain modules

Domain modules for the admin dashboard.

• gamesheet_sdk.admin
  • gamesheet_sdk.admin.associations
  • gamesheet_sdk.admin.cli
  • gamesheet_sdk.admin.divisions
  • gamesheet_sdk.admin.games
  • gamesheet_sdk.admin.ipad_keys
  • gamesheet_sdk.admin.leagues
  • gamesheet_sdk.admin.referees
  • gamesheet_sdk.admin.roster
  • gamesheet_sdk.admin.seasons
  • gamesheet_sdk.admin.shared
  • gamesheet_sdk.admin.teams
• gamesheet_sdk.admin.associations
  • Association
  • get_association()
  • list_associations()
• gamesheet_sdk.admin.divisions
  • Division
  • list_division_teams()
  • get_division()
  • list_divisions()
  • create_division()
  • update_division()
  • delete_division()
• gamesheet_sdk.admin.ipad_keys
  • IPadKey
  • list_ipad_keys()
• gamesheet_sdk.admin.leagues
  • League
  • get_league()
  • list_leagues()
• gamesheet_sdk.admin.referees
  • Referee
  • RefereeReport
  • get_referee()
  • get_referee_report()
  • create_referee()
  • update_referee()
  • delete_referee()
  • list_referees()
• gamesheet_sdk.admin.seasons
  • Season
  • SeasonDetail
  • list_seasons()
  • get_season()
• gamesheet_sdk.admin.teams
  • Team
  • list_teams()
  • get_team()
  • update_team()
  • create_team()
  • delete_team()

Admin games package

Game retrieval and management for scheduled, completed, and bracket games.

• gamesheet_sdk.admin.games
  • Broadcaster
  • Game
  • GameData
  • Location
  • Relationship
  • RelationshipData
  • ScheduledGame
  • ScheduledGameAttributes
  • ScheduledGameData
  • ScheduledGameRelationships
  • Scorekeeper
  • TeamInfo
  • list_broadcasters()
  • validate_broadcaster_key()
  • get_game()
  • list_brackets()
  • list_completed()
  • download_completed_game_pdf()
  • get_completed_game()
  • validate_game_type()
  • get_location()
  • list_locations()
  • validate_location()
  • create_scheduled_game()
  • delete_scheduled_game()
  • get_scheduled_game()
  • list_scheduled()
  • update_scheduled_game()
• gamesheet_sdk.admin.games.brackets module
  • list_completed()
  • list_brackets()
  • get_game()
• gamesheet_sdk.admin.games.broadcasters module
  • list_broadcasters()
  • validate_broadcaster_key()
• gamesheet_sdk.admin.games.completed module
  • get_completed_game()
  • download_completed_game_pdf()
• gamesheet_sdk.admin.games.helpers module
  • validate_game_type()
• gamesheet_sdk.admin.games.locations module
  • list_locations()
  • get_location()
  • validate_location()
• gamesheet_sdk.admin.games.models module
  • Broadcaster
  • Location
  • TeamInfo
  • Game
  • Scorekeeper
  • GameData
  • RelationshipData
  • Relationship
  • ScheduledGameRelationships
  • ScheduledGameAttributes
  • ScheduledGameData
  • ScheduledGame
• gamesheet_sdk.admin.games.scheduled module
  • list_scheduled()
  • create_scheduled_game()
  • get_scheduled_game()
  • update_scheduled_game()
  • delete_scheduled_game()

Admin roster package

Player and coach roster management.

• gamesheet_sdk.admin.roster
  • Coach
  • Player
  • assign_coach()
  • assign_player()
  • assign_team_coach()
  • assign_team_player()
  • create_coach()
  • create_player()
  • create_team_coach()
  • create_team_player()
  • delete_coach()
  • delete_player()
  • delete_team_coach()
  • delete_team_player()
  • get_coach()
  • get_coach_penalty_report()
  • get_player()
  • get_player_penalty_report()
  • get_team_coach()
  • get_team_player()
  • list_coaches()
  • list_players()
  • list_team_coaches()
  • list_team_players()
  • unassign_coach()
  • unassign_player()
  • unassign_team_coach()
  • unassign_team_player()
  • update_coach()
  • update_player()
  • update_team_coach()
  • update_team_player()
• gamesheet_sdk.admin.roster.coaches module
  • get_coach()
  • list_coaches()
  • create_coach()
  • update_coach()
  • list_team_coaches()
  • get_team_coach()
  • create_team_coach()
  • update_team_coach()
  • delete_coach()
  • unassign_coach()
  • delete_team_coach()
  • assign_coach()
  • assign_team_coach()
  • unassign_team_coach()
  • get_coach_penalty_report()
• gamesheet_sdk.admin.roster.helpers module
  • get_team_for_roster_update()
  • update_team_roster()
• gamesheet_sdk.admin.roster.models module
  • Player
  • Coach
  • parse_player()
  • parse_coach()
• gamesheet_sdk.admin.roster.players module
  • get_player()
  • list_players()
  • list_team_players()
  • create_player()
  • get_team_player()
  • create_team_player()
  • update_player()
  • update_team_player()
  • delete_player()
  • unassign_player()
  • delete_team_player()
  • assign_player()
  • assign_team_player()
  • unassign_team_player()
  • get_player_penalty_report()

Admin CLI

Admin CLI framework and command implementations.

• gamesheet_sdk.admin.cli
  • main()
• gamesheet_sdk.admin.cli.constants module
• gamesheet_sdk.admin.cli.helpers module
  • build_authenticated_session()
  • run_action_or_exit()
  • run_team_update()
  • run_team_create()
  • run_team_delete()
  • run_roster_assign_with_output()
  • run_roster_unassign()
  • run_roster_update_with_output()
  • run_roster_create_with_output()
• gamesheet_sdk.admin.cli.main module
  • main()
• gamesheet_sdk.admin.cli.shared package
  • common_output_options()
  • get_fields_option()
  • get_local_timezone_name()
  • get_local_timezone_offset()
  • list_columns_option()
  • parse_flexible_datetime()
  • render_get_command()
  • render_list_command()
  • render_penalty_report()
  • resolve_create_times()
  • resolve_datetime_input()
  • resolve_update_times()
  • team_create_options()
  • team_update_options()
  • validate_end_after_start()
  • validate_no_input_conflict()
  • Submodules
• gamesheet_sdk.admin.cli.shared.datetime_helpers module
  • get_local_timezone_name()
  • get_local_timezone_offset()
  • parse_flexible_datetime()
  • validate_no_input_conflict()
  • resolve_datetime_input()
  • validate_end_after_start()
  • resolve_create_times()
  • resolve_update_times()
• gamesheet_sdk.admin.cli.shared.decorators module
  • common_output_options()
  • list_columns_option()
  • get_fields_option()
  • team_update_options()
  • team_create_options()
• gamesheet_sdk.admin.cli.shared.rendering module
  • render_get_command()
  • render_list_command()
  • render_penalty_report()
• gamesheet_sdk.admin.cli.commands package
  • register_teams_roster_group()
  • Submodules
• gamesheet_sdk.admin.cli.commands.associations module
• gamesheet_sdk.admin.cli.commands.completion module
• gamesheet_sdk.admin.cli.commands.divisions module
• gamesheet_sdk.admin.cli.commands.games module
• gamesheet_sdk.admin.cli.commands.games_brackets module
• gamesheet_sdk.admin.cli.commands.games_completed module
• gamesheet_sdk.admin.cli.commands.games_scheduled module
• gamesheet_sdk.admin.cli.commands.ipad_keys module
• gamesheet_sdk.admin.cli.commands.leagues module
• gamesheet_sdk.admin.cli.commands.locations module
• gamesheet_sdk.admin.cli.commands.login module
• gamesheet_sdk.admin.cli.commands.referees module
• gamesheet_sdk.admin.cli.commands.roster module
• gamesheet_sdk.admin.cli.commands.roster_coaches module
• gamesheet_sdk.admin.cli.commands.roster_players module
• gamesheet_sdk.admin.cli.commands.seasons module
• gamesheet_sdk.admin.cli.commands.teams module
• gamesheet_sdk.admin.cli.commands.teams_roster module
  • register_teams_roster_group()
• gamesheet_sdk.admin.cli.commands.teams_roster_coaches module
• gamesheet_sdk.admin.cli.commands.teams_roster_players module

Teams CLI

Teams CLI framework and command implementations.

• gamesheet_sdk.teams
  • LookupValue
  • TeamsAuthenticatedSession
  • TeamsLoginFlow
  • list_lookups()
  • refresh_access_token()
• gamesheet_sdk.teams.cli
  • main()
• gamesheet_sdk.teams.cli.main module
  • main()
• gamesheet_sdk.teams.cli.commands package
  • Submodules
• gamesheet_sdk.teams.cli.commands.completion module
• gamesheet_sdk.teams.cli.commands.login module