Merge pull request #22 from nathanblumenfeld/njb_dev

+examples notebook, docs update
nathanblumenfeld · Sep 2, 2022 · eb3e5b8 · eb3e5b8
2 parents 4045f3b + 25b8882
commit eb3e5b8
Show file tree

Hide file tree

Showing 13 changed files with 12,267 additions and 8 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,4 @@
 include DESCRIPTION.rst
 include *.parquet
+include *.csv
 recursive-include collegebaseball/data *
diff --git a/collegebaseball/__init__.py b/collegebaseball/__init__.py
@@ -1,6 +1,6 @@
 from .ncaa_scraper import ncaa_team_season_roster, ncaa_team_roster, \
     ncaa_career_stats, ncaa_team_stats, ncaa_team_totals, \
-    ncaa_team_game_logs, ncaa_player_game_logs
+    ncaa_team_game_logs, ncaa_player_game_logs, ncaa_team_results
 from .lookup import lookup_season_ids, lookup_season_reverse, \
     lookup_season_id, lookup_seasons_played, lookup_school, \
     lookup_player, _lookup_season_info, _lookup_school_info, \
@@ -17,6 +17,10 @@
     get_seasons_path, get_seasons_table, \
     get_rosters_path, get_rosters_table, \
     get_season_linear_weights
+from .download_utils import download_rosters, \
+    download_player_game_logs, download_season_rosters, \
+    download_team_results, download_team_stats, \
+    download_team_totals
 
 import sys
 import warnings

diff --git a/collegebaseball/boydsworld_scraper.py b/collegebaseball/boydsworld_scraper.py
@@ -18,8 +18,9 @@ def boydsworld_team_results(school, start, end=None, vs="all",
 
     Args:
         school (str): team whose games to select
-        start (int): the start year of games, 1992 <= start <= 2021
-        end (int):  the end season of games, 1992 <= end <= 2021
+        start (int): the start year of games, 1992 <= start <= 2022
+        end (int):  the end season of games, 1992 <= end <= 2022
+
         vs (str): school to filter games against. default: 'all'
         parse_dates (bool): whether to parse data into datetime64
 

diff --git a/collegebaseball/download_utils.py b/collegebaseball/download_utils.py
@@ -114,7 +114,7 @@ def download_team_stats(seasons: list[int], variant: str, divisions: list[int],
             if save:
                 res.to_csv('collegebaseball/data/d'+str(division)+'_'+str(season) +
                            '_'+variant+'_stats.csv', index=False)
-    return res, failures
+    return res
 
 
 def download_team_totals(seasons: list[int], variant: str, divisions: list[int], save=True):

diff --git a/docs/source/gamelogs.rst b/docs/source/gamelogs.rst
@@ -1,3 +1,4 @@
+==================
 Game-by-Game Stats
 ==================
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,3 +1,4 @@
+===========================================
 Welcome to collegebaseball's documentation!
 ===========================================
 

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -1,3 +1,4 @@
+============
 Installation
 ============
 

diff --git a/docs/source/lookup.rst b/docs/source/lookup.rst
@@ -1,3 +1,4 @@
+================
 Lookup Functions
 ================
 

diff --git a/docs/source/metrics.rst b/docs/source/metrics.rst
@@ -1,3 +1,4 @@
+=======
 Metrics
 =======
 

diff --git a/docs/source/results.rst b/docs/source/results.rst
@@ -1,3 +1,4 @@
+============
 Game Results
 ============
 
@@ -17,12 +18,13 @@ Team Results
    A function to scrape Division I game results, from boydsworld.com
 
    :school (str): team whose games to select
-   :start (int): the start year of games, 1992 <= x <= 2021
-   :end (int, optional):  the end season of games, 1992 <= x <= 2021
+   :start (int): the start year of games, 1992 <= x <= 2022
+   :end (int, optional):  the end season of games, 1992 <= x <= 2022
    :vs (str, optional): school to filter games against. default: 'all'
    :parse_dates (bool, optional): whether to parse data into datetime64
    :return (pd.DataFrame): of all games played for a given team inclusive of start & end
 
+
 .. py:function:: win_pct.calculate_actual_win_pct(games):
 
    A function to calculate the winning percentage as

diff --git a/docs/source/schools.rst b/docs/source/schools.rst
@@ -1,6 +1,6 @@
+====================
 School Names and IDs
-=====================
-
+====================
 
 =================================== ================================= ============ =========== 
 ncaa_name                           bd_name                           school_id    division   

diff --git a/docs/source/season_stats.rst b/docs/source/season_stats.rst
@@ -1,3 +1,4 @@
+============
 Season Stats
 ============
 

diff --git a/examples.ipynb b/examples.ipynb