gamesheet_sdk.admin.cli.shared package

Shared CLI utilities.

gamesheet_sdk.admin.cli.shared.columns_option(func)

Add the –columns option that restricts output to a subset of keys.

One option covers both shapes of output: on a list it selects table columns, and on a get / create / update it selects fields of the single rendered object. Both are “show me only these keys”, so there is one name for it, and -f is left to mean --force everywhere.

Parameters:

func (F) – The Click command function to decorate.

Returns:

F – The decorated function with the –columns option.

Return type:

F

gamesheet_sdk.admin.cli.shared.common_output_options(func)

Add standard –format and –output options to command.

Parameters:

func (F) – The Click command function to decorate

Returns:

F – The decorated function with –format and –output options

Return type:

F

gamesheet_sdk.admin.cli.shared.get_local_timezone_name()

Get the local system timezone name (IANA format).

Returns the timezone name like ‘America/New_York’, ‘UTC’, etc. Falls back to ‘UTC’ if unable to determine.

Returns:

str – IANA timezone name

Return type:

str

gamesheet_sdk.admin.cli.shared.get_local_timezone_offset()

Get the local timezone offset in minutes from UTC.

Returns the offset as a signed integer (negative for west of UTC, positive for east). For example, EDT (UTC-4) returns -240.

Returns:

int – Timezone offset in minutes

Return type:

int

gamesheet_sdk.admin.cli.shared.parse_flexible_datetime(raw)

Parse a flexible datetime string into a naive datetime.datetime preserving face values.

Uses dateutil.parser.parse for flexible input. Any timezone information is stripped — the returned datetime.datetime contains the literal hour/minute/second the user typed. This matches GameSheet’s API behavior, which stores and displays time values as-is without timezone conversion.

Parameters:

raw (str) – A human-readable datetime string

Returns:

datetime.datetime – A timezone-naive datetime.datetime with the face-value time

Raises:

UsageError – If the string cannot be parsed

Return type:

datetime

gamesheet_sdk.admin.cli.shared.player_update_options(func)

Add common player update options.

Parameters:

func (F) – The Click command function to decorate

Returns:

F – The decorated function with player update options

Return type:

F

gamesheet_sdk.admin.cli.shared.render_get_command(data, output_format, output_path, columns_spec=None)

Render get command output (single object as key-value pairs).

Parameters:

• data (dict[str, Any] | BaseModel) – The object to render (dict or pydantic model)

• output_format (str) – Output format (json, yaml, csv, tsv, or tabulate format)

• output_path (str | None) – Optional file path to write output to

• columns_spec (str | None) – Optional comma-separated column names to include

gamesheet_sdk.admin.cli.shared.render_list_command(items, output_format, output_path, columns_spec=None)

Render list command output (table of objects).

Parameters:

• items (list[Any]) – List of objects to render (dicts or pydantic models)

• output_format (str) – Output format (json, yaml, csv, tsv, or tabulate format)

• output_path (str | None) – Optional file path to write output to

• columns_spec (str | None) – Optional comma-separated column names to include

gamesheet_sdk.admin.cli.shared.render_penalty_report(report, output_format, output_path)

Render penalty report output.

Parameters:

• report (dict[str, Any]) – The penalty report dictionary to render

• output_format (str) – Output format (json or yaml)

• output_path (str | None) – Optional file path to write output to

gamesheet_sdk.admin.cli.shared.resolve_create_times(start_raw, end_raw, duration)

Resolve start/end for create: exactly 2 of 3 required.

Parameters:

• start_raw (str | None) – Raw start datetime string, or None

• end_raw (str | None) – Raw end datetime string, or None

• duration (int | None) – Duration in minutes, or None

Returns:

tuple[str, str] – (start_utc_iso, end_utc_iso) tuple

Raises:

UsageError – If fewer than 2 of 3 are provided, or if all 3 are inconsistent, or end <= start

Return type:

tuple[str, str]

gamesheet_sdk.admin.cli.shared.resolve_datetime_input(combined, date_part, time_part, label)

Merge split date+time inputs into one string, or return combined.

Parameters:

• combined (str | None) – The --start-datetime or --end-datetime value

• date_part (str | None) – The --start-date or --end-date value

• time_part (str | None) – The --start-time or --end-time value

• label (str) – "start" or "end", for error messages

Returns:

str | None – A merged datetime string or None

Raises:

UsageError – If only one of date/time is provided

Return type:

str | None

gamesheet_sdk.admin.cli.shared.resolve_update_times(start_raw, end_raw, duration, current_start, current_end)

Resolve start/end for update: partial inputs OK.

Uses current game values as fallback when the user provides fewer than 2 inputs.

Parameters:

• start_raw (str | None) – New start datetime string, or None

• end_raw (str | None) – New end datetime string, or None

• duration (int | None) – Duration in minutes, or None

• current_start (str) – Current game start time (ISO 8601)

• current_end (str) – Current game end time (ISO 8601)

Returns:

tuple[str, str] – (start_utc_iso, end_utc_iso) tuple

Return type:

tuple[str, str]

gamesheet_sdk.admin.cli.shared.team_create_options(func)

Add common team create options.

Parameters:

func (F) – The Click command function to decorate

Returns:

F – The decorated function with team create options

Return type:

F

gamesheet_sdk.admin.cli.shared.team_update_options(func)

Add common team update options.

Parameters:

func (F) – The Click command function to decorate

Returns:

F – The decorated function with team update options

Return type:

F

gamesheet_sdk.admin.cli.shared.validate_end_after_start(start_dt, end_dt)

Raise if end is not strictly after start.

Parameters:

• start_dt (datetime.datetime) – Start datetime.datetime (UTC)

• end_dt (datetime.datetime) – End datetime.datetime (UTC)

Raises:

UsageError – If end <= start

gamesheet_sdk.admin.cli.shared.validate_no_input_conflict(combined, date_part, time_part, label)

Raise if combined and split inputs are both provided.

Parameters:

• combined (str | None) – The --start-datetime or --end-datetime value

• date_part (str | None) – The --start-date or --end-date value

• time_part (str | None) – The --start-time or --end-time value

• label (str) – "start" or "end", for error messages

Raises:

UsageError – If combined and any split input coexist

Submodules

• gamesheet_sdk.admin.cli.shared.datetime_helpers module
  • get_local_timezone_name()
  • get_local_timezone_offset()
  • parse_flexible_datetime()
  • resolve_create_times()
  • resolve_datetime_input()
  • resolve_update_times()
  • validate_end_after_start()
  • validate_no_input_conflict()
• gamesheet_sdk.admin.cli.shared.decorators module
  • columns_option()
  • common_output_options()
  • player_update_options()
  • team_create_options()
  • team_update_options()
• gamesheet_sdk.admin.cli.shared.game_runner module
  • resolve_season_id()
  • run_create()
  • run_delete()
  • run_get()
  • run_list()
  • run_update()
• gamesheet_sdk.admin.cli.shared.rendering module
  • render_get_command()
  • render_list_command()
  • render_penalty_report()