standings()

Author: toddrob99

README.md

@@ -32,6 +32,8 @@ If you install manually, be sure to also install requests.
 
 * `statsapi.roster()` - generate a list of players on a team's roster
 
+* `statsapi.standings()` - generate a formatted list of standings for a given league/date
+
 ## Example Use
 
 ### Print the number of games won by the Oakland Athletics in 2018
@@ -84,3 +86,11 @@ then feed into max() to find the longest value and its length
 longest_team_name = max([x['name'] for x in statsapi.get('teams',{'sportIds':1,'activeStatus':'Yes','fields':'teams,name'})['teams']],key=len)
 print('The team with the longest name is %s, at %s characters.' % (longest_team_name, len(longest_team_name)))
 ```
+
+### Print the standings from July 4, 2018
+
+Use `statsapi.standings()` with the `date` parameters
+
+```
+print(statsapi.standings(date='07/04/2018'))
+```

statsapi/__init__.py

@@ -659,9 +659,44 @@ def league_leaders(leaderCategories,leagueId=None,season=None):
     return "This function is not yet available."
 
 def standings(leagueId=None,season=None,standingsTypes=None,date=None):
-    """Get standings for a given league and season.
+    """Get formatted standings for a given league and season.
+    Will include division and wildcard standings 
     
     Format for date = 'MM/DD/YYYY', e.g. '04/24/2019'
+
+    Example use:
+
+    Print National League standings from 09/27/2008
+    
+    print( statsapi.standings(leagueId=104,date='09/27/2008') )
+
+    Output:
+
+    National League Central
+    Rank Team                   W   L   GB  (E#) WC Rank WC GB (E#)
+     1   Chicago Cubs          97  63   -    -      -      -    -
+     2   Milwaukee Brewers     89  72  8.5   E      1      -    -
+     3   Houston Astros        85  75  12.0  E      3     3.5   E
+     4   St. Louis Cardinals   85  76  12.5  E      4     4.0   E
+     5   Cincinnati Reds       74  87  23.5  E      7    15.0   E
+     6   Pittsburgh Pirates    66  95  31.5  E     11    23.0   E
+
+    National League West
+    Rank Team                   W   L   GB  (E#) WC Rank WC GB (E#)
+     1   Los Angeles Dodgers   84  77   -    -      -      -    -
+     2   Arizona Diamondbacks  81  80  3.0   E      6     8.0   E
+     3   Colorado Rockies      74  87  10.0  E      8    15.0   E
+     4   San Francisco Giants  71  90  13.0  E     10    18.0   E
+     5   San Diego Padres      63  98  21.0  E     12    26.0   E
+
+    National League East
+    Rank Team                   W   L   GB  (E#) WC Rank WC GB (E#)
+     1   Philadelphia Phillies 91  70   -    -      -      -    -
+     2   New York Mets         89  72  2.0   E      2      -    -
+     3   Florida Marlins       83  77  7.5   E      5     5.5   E
+     4   Atlanta Braves        72  89  19.0  E      9    17.0   E
+     5   Washington Nationals  59  101 31.5  E     13    29.5   E
+    
     """
     if not leagueId: leagueId = '103,104'
     params = {'leagueId':leagueId}