From 8c8fe1e017b50fc650b865dc0a4c7cb4d0c363b2 Mon Sep 17 00:00:00 2001 From: Jensen Holm Date: Sat, 7 Sep 2024 17:11:21 -0400 Subject: [PATCH] readme update --- README.md | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4fec0db..5bed825 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Interact with the MLB Stats API to retrieve various types of baseball-related da Getting the full regular season schedules for years 2023 & 2024 Code: + ```python from pybaseball_live.schedule import schedule @@ -30,23 +31,26 @@ if __name__ == "__main__": ``` Output: -┌─────────┬──────────┬────────────┬──────────────────────┬──────────────────────┬───────┬──────────┬───────────────────────┐ -│ game_id ┆ time ┆ date ┆ away ┆ home ┆ state ┆ venue_id ┆ venue_name │ -│ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │ -│ i64 ┆ str ┆ date ┆ str ┆ str ┆ str ┆ i64 ┆ str │ -╞═════════╪══════════╪════════════╪══════════════════════╪══════════════════════╪═══════╪══════════╪═══════════════════════╡ -│ 718768 ┆ 07:08 PM ┆ 2023-03-30 ┆ Chicago White Sox ┆ Houston Astros ┆ F ┆ 2392 ┆ Minute Maid Park │ -│ 718780 ┆ 01:05 PM ┆ 2023-03-30 ┆ Atlanta Braves ┆ Washington Nationals ┆ F ┆ 3309 ┆ Nationals Park │ -│ 718777 ┆ 02:20 PM ┆ 2023-03-30 ┆ Milwaukee Brewers ┆ Chicago Cubs ┆ F ┆ 17 ┆ Wrigley Field │ -│ 718774 ┆ 04:10 PM ┆ 2023-03-30 ┆ New York Mets ┆ Miami Marlins ┆ F ┆ 4169 ┆ loanDepot park │ -│ 718781 ┆ 01:05 PM ┆ 2023-03-30 ┆ San Francisco Giants ┆ New York Yankees ┆ F ┆ 3313 ┆ Yankee Stadium │ -│ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … │ -│ 746577 ┆ 03:10 PM ┆ 2024-09-29 ┆ Houston Astros ┆ Cleveland Guardians ┆ S ┆ 5 ┆ Progressive Field │ -│ 744880 ┆ 03:07 PM ┆ 2024-09-29 ┆ Miami Marlins ┆ Toronto Blue Jays ┆ S ┆ 14 ┆ Rogers Centre │ -│ 745282 ┆ 03:05 PM ┆ 2024-09-29 ┆ St. Louis Cardinals ┆ San Francisco Giants ┆ S ┆ 2395 ┆ Oracle Park │ -│ 745932 ┆ 03:10 PM ┆ 2024-09-29 ┆ New York Mets ┆ Milwaukee Brewers ┆ S ┆ 32 ┆ American Family Field │ -│ 747147 ┆ 03:10 PM ┆ 2024-09-29 ┆ San Diego Padres ┆ Arizona Diamondbacks ┆ S ┆ 15 ┆ Chase Field │ -└─────────┴──────────┴────────────┴──────────────────────┴──────────────────────┴───────┴──────────┴───────────────────────┘ +``` +shape: (4_860, 8) +┌─────────┬──────────┬────────────┬─────────────────────┬──────────────────────┬───────┬──────────┬───────────────────────┐ +│ game_id ┆ time ┆ date ┆ away ┆ home ┆ state ┆ venue_id ┆ venue_name │ +│ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │ +│ i64 ┆ str ┆ date ┆ str ┆ str ┆ str ┆ i64 ┆ str │ +╞═════════╪══════════╪════════════╪═════════════════════╪══════════════════════╪═══════╪══════════╪═══════════════════════╡ +│ 718774 ┆ 04:10 PM ┆ 2023-03-30 ┆ New York Mets ┆ Miami Marlins ┆ F ┆ 4169 ┆ loanDepot park │ +│ 718768 ┆ 07:08 PM ┆ 2023-03-30 ┆ Chicago White Sox ┆ Houston Astros ┆ F ┆ 2392 ┆ Minute Maid Park │ +│ 718780 ┆ 01:05 PM ┆ 2023-03-30 ┆ Atlanta Braves ┆ Washington Nationals ┆ F ┆ 3309 ┆ Nationals Park │ +│ 718777 ┆ 02:20 PM ┆ 2023-03-30 ┆ Milwaukee Brewers ┆ Chicago Cubs ┆ F ┆ 17 ┆ Wrigley Field │ +│ 718772 ┆ 04:10 PM ┆ 2023-03-30 ┆ Toronto Blue Jays ┆ St. Louis Cardinals ┆ F ┆ 2889 ┆ Busch Stadium │ +│ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … │ +│ 746577 ┆ 03:10 PM ┆ 2024-09-29 ┆ Houston Astros ┆ Cleveland Guardians ┆ S ┆ 5 ┆ Progressive Field │ +│ 745282 ┆ 03:05 PM ┆ 2024-09-29 ┆ St. Louis Cardinals ┆ San Francisco Giants ┆ S ┆ 2395 ┆ Oracle Park │ +│ 744880 ┆ 03:07 PM ┆ 2024-09-29 ┆ Miami Marlins ┆ Toronto Blue Jays ┆ S ┆ 14 ┆ Rogers Centre │ +│ 745932 ┆ 03:10 PM ┆ 2024-09-29 ┆ New York Mets ┆ Milwaukee Brewers ┆ S ┆ 32 ┆ American Family Field │ +│ 747147 ┆ 03:10 PM ┆ 2024-09-29 ┆ San Diego Padres ┆ Arizona Diamondbacks ┆ S ┆ 15 ┆ Chase Field │ +└─────────┴──────────┴────────────┴─────────────────────┴──────────────────────┴───────┴──────────┴───────────────────────┘ +``` ## Contributing