API reference
Every page here is generated from sportypy's docstrings on each build.
Surfaces
One class per sport, and one subclass per league with that league's rule-book dimensions.
| Sport | Base class | League classes |
|---|---|---|
| Baseball | BaseballField | 6 |
| Basketball | BasketballCourt | 6 |
| Curling | CurlingSheet | 2 |
| Football | FootballField | 4 |
| Hockey | HockeyRink | 11 |
| Lacrosse | LacrosseField | 7 |
| Soccer | SoccerPitch | 5 |
| Softball | SoftballField | 1 |
| Tennis | TennisCourt | 6 |
| Volleyball | VolleyballCourt | 3 |
Shared methods
Plotting and display: the plotting helpers (scatter, heatmap, contour, hexbin, arrow, ...) and the display methods every surface has.
Features
The Features pages document the shapes each surface is drawn from: useful when adding a league or a sport.