Skip to main content

sportsdataverse.cfb package

Submodules​

sportsdataverse.cfb.cfb_loaders module​

sportsdataverse.cfb.cfb_loaders.get_cfb_teams()​

Load college football team ID information and logos

Example:

cfb_df = sportsdataverse.cfb.cfb_teams()

Args:

Returns:

pd.DataFrame: Pandas dataframe containing teams available for the requested seasons.

sportsdataverse.cfb.cfb_loaders.load_cfb_pbp(seasons: List[int])​

Load college football play by play data going back to 2003

Example:

cfb_df = sportsdataverse.cfb.load_cfb_pbp(seasons=range(2003,2021))

Args:

seasons (list): Used to define different seasons. 2003 is the earliest available season.

Returns:

pd.DataFrame: Pandas dataframe containing the play-by-plays available for the requested seasons.

Raises:

ValueError: If season is less than 2003.

sportsdataverse.cfb.cfb_loaders.load_cfb_rosters(seasons: List[int])​

Load roster data

Example:

cfb_df = sportsdataverse.cfb.load_cfb_rosters(seasons=range(2014,2021))

Args:

seasons (list): Used to define different seasons. 2014 is the earliest available season.

Returns:

pd.DataFrame: Pandas dataframe containing rosters available for the requested seasons.

Raises:

ValueError: If season is less than 2014.

sportsdataverse.cfb.cfb_loaders.load_cfb_schedule(seasons: List[int])​

Load college football schedule data

Example:

cfb_df = sportsdataverse.cfb.load_cfb_schedule(seasons=range(2002,2021))

Args:

seasons (list): Used to define different seasons. 2002 is the earliest available season.

Returns:

pd.DataFrame: Pandas dataframe containing the schedule for the requested seasons.

Raises:

ValueError: If season is less than 2002.

sportsdataverse.cfb.cfb_loaders.load_cfb_team_info(seasons: List[int])​

Load college football team info

Example:

cfb_df = sportsdataverse.cfb.load_cfb_team_info(seasons=range(2002,2021))

Args:

seasons (list): Used to define different seasons. 2002 is the earliest available season.

Returns:

pd.DataFrame: Pandas dataframe containing the team info available for the requested seasons.

Raises:

ValueError: If season is less than 2002.

sportsdataverse.cfb.cfb_pbp module​

class sportsdataverse.cfb.cfb_pbp.CFBPlayProcess(gameId=0, raw=False, path_to_json='/')​

Bases: object

__init__(gameId=0, raw=False, path_to_json='/')​

Initialize self. See help(type(self)) for accurate signature.

cfb_pbp_disk()​

create_box_score()​

espn_cfb_pbp()​

espn_cfb_pbp() - Pull the game by id. Data from API endpoints: college-football/playbyplay, college-football/summary

Args:

game_id (int): Unique game_id, can be obtained from cfb_schedule().

Returns:

Dict: Dictionary of game data with keys - “gameId”, “plays”, “boxscore”, “header”, “broadcasts”,

    “videos”, “playByPlaySource”, “standings”, “leaders”, “timeouts”, “homeTeamSpread”, “overUnder”,
    “pickcenter”, “againstTheSpread”, “odds”, “predictor”, “winprobability”, “espnWP”,
    “gameInfo”, “season”

Example:

cfb_df = sportsdataverse.cfb.CFBPlayProcess(gameId=401256137).espn_cfb_pbp()

gameId( = 0)​

path_to_json( = '/')​

ran_cleaning_pipeline( = False)​

ran_pipeline( = False)​

raw( = False)​

run_cleaning_pipeline()​

run_processing_pipeline()​

sportsdataverse.cfb.cfb_schedule module​

sportsdataverse.cfb.cfb_schedule.espn_cfb_calendar(season=None, groups=None, ondays=None)​

espn_cfb_calendar - look up the men’s college football calendar for a given season

Args:

season (int): Used to define different seasons. 2002 is the earliest available season.
groups (int): Used to define different divisions. 80 is FBS, 81 is FCS.
ondays (boolean): Used to return dates for calendar ondays

Returns:

pd.DataFrame: Pandas dataframe containing calendar dates for the requested season.

Raises:

ValueError: If season is less than 2002.

sportsdataverse.cfb.cfb_schedule.espn_cfb_schedule(dates=None, week=None, season_type=None, groups=None, limit=500)​

espn_cfb_schedule - look up the college football schedule for a given season

Args:

dates (int): Used to define different seasons. 2002 is the earliest available season.
week (int): Week of the schedule.
groups (int): Used to define different divisions. 80 is FBS, 81 is FCS.
season_type (int): 2 for regular season, 3 for post-season, 4 for off-season.
limit (int): number of records to return, default: 500.

Returns:

pd.DataFrame: Pandas dataframe containing schedule dates for the requested season.

sportsdataverse.cfb.cfb_teams module​

sportsdataverse.cfb.cfb_teams.espn_cfb_teams(groups=None)​

espn_cfb_teams - look up the college football teams

Args:

groups (int): Used to define different divisions. 80 is FBS, 81 is FCS.

Returns:

pd.DataFrame: Pandas dataframe containing schedule dates for the requested season.

sportsdataverse.cfb.cfb_espn module​

sportsdataverse.cfb.cfb_espn.espn_cfb_box_score(gameID:int) -> pd.DataFrame()​

getEspnCfbBoxScore - Retrives the JSON file corresponding to a real ESPN CFB gameID, and parses it into a pandas dataframe containing box score data from that game.

Args: gameId(int): Required input. This should correspond to the ESPN CFB gameID you want box score stats from.

Returns:

A pd.DataFrame() object. If there are box score stats for this gameID,
you will recive a pandas dataframe with any box score stats that ESPN has
for that gameID. If there isn't any box score stats for that gameID, or
the inputted gameID doesn't correspond to an actual gameID for ESPN's CFB API,
the function will return an empty dataframe.

Example: sdv.cfb.getEspnCfbBoxScore(401301018)

Module contents​