API reference

Every public function, grouped by what it works with. Each page gives the signature, the arguments and what the function returns and raises.

Teams

Function	What it does
resolve	Canonical team_id(s) for team values in one league.
suggest	Up to n (team_id, name) candidates for a value that did not resolve, best first.
teams	The bundled team index: one row per (league, team_id), with names, abbreviation, conference and colors.

Colors

Function	What it does
palette	A {team: "#hex"} dict for a league, ready for seaborn, Plotly, Altair, Bokeh or PyPalettes.
team_colors	One "#hex" (or None) per team value, in the same container the values came in.

Logos and headshots

Function	What it does
logo_url	The CDN URL of a team's logo or wordmark, chosen for the season.
logo_image	The team's mark as a PIL image (downloaded once, then cached).
marks	Every archived mark for one team, best first.
headshot_url	A headshot URL for one player.

Plots and tables

Function	What it does
add_logos	Add team logos to a plot or table of any supported library.
add_wordmarks	Add team wordmarks to a plot or table of any supported library.
add_headshots	Add player headshots to a plot or table of any supported library.
axis_logos	Replace an axis' team labels with team logos on a plot of any supported library.
surface	Draw the league's playing surface with sportypy, in a team's colors.
court_coords	Convert stats.nba.com / stats.wnba.com shot locations to the court frame sportypy draws.

Housekeeping

Function	What it does
versions	What a bug report needs: the package version, the bundled-index version, and the cached manifest's date.
clear_cache	Delete everything sdvplot has cached (manifest, images, rasters, nflverse).

Errors and warnings

Errors and warnings: the warning sdvplot emits and the errors it raises, with what each means.