-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from armstjc/0.1.2-The-Spell-Check-update
0.1.2: The "Spell Check" update
- Loading branch information
Showing
39 changed files
with
13,418 additions
and
13,417 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{ | ||
"current_verson": "4.5.2" | ||
"current_version": "4.5.2" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Creation Date: 08/30/2023 01:13 EDT | ||
# Last Updated Date: 02/24/2023 03:30 PM EST | ||
# Last Updated Date: 04/04/2024 05:10 PM EDT | ||
# Author: Joseph Armstrong ([email protected]) | ||
# File Name: __init__.py | ||
# Purpose: Allows for the python package to function, | ||
|
@@ -16,19 +16,19 @@ | |
- `cfbd_json_py.coaches`: | ||
Holds functions for you to get coaching data (past and present). | ||
- `cfbd_json_py.conferences`: | ||
Holds functions for you to get information for CFB confrences. | ||
Holds functions for you to get information for CFB conferences. | ||
- `cfbd_json_py.draft`: | ||
Holds functions for you to get NFL draft information/data for | ||
various players in the CFBD API | ||
- `cfbd_json_py.drives`: | ||
Holds functions for you to get data for offensive and/or defensive drives | ||
within the CFBD API. | ||
- `cfbd_json_py.games`: | ||
Holds functions for you to get various datapoints pertaining to | ||
Holds functions for you to get various data points pertaining to | ||
actual CFB games within the CFBD API. | ||
- `cfbd_json_py.metrics`: | ||
Holds functions to allow you to calculate | ||
or retrive various advanced metrics | ||
or retrieve various advanced metrics | ||
from the CFBD API. | ||
- `cfbd_json_py.players`: | ||
Holds functions for you to get various | ||
|
@@ -44,7 +44,7 @@ | |
Holds functions to allow you to get various team ratings data | ||
(like SP+, SRS, and Elo team ratings) from the CFBD API. | ||
- `cfbd_json_py.recruiting`: | ||
Holds functions for you to access CFB recruting data and information, | ||
Holds functions for you to access CFB recruiting data and information, | ||
as well as team and player ratings for recruiting. | ||
- `cfbd_json_py.stats`: | ||
Holds functions for you to get various team stats from the CFBD API. | ||
|
@@ -64,7 +64,7 @@ | |
If you have a CFBD API key, | ||
you have three ways to set it for this python package to use: | ||
1. Declare the API key as a string variable | ||
in a python script (not reccomended, extreme security risk). | ||
in a python script (not recommended, extreme security risk). | ||
2. Declare the API key in your environment as `CFBD_API_KEY`. | ||
- `cfbd_json_py` will first look for your environment, | ||
if you don't declare the API key as a string variable, | ||
|
@@ -87,7 +87,7 @@ | |
``` | ||
> **NOTE:** *In a future version, | ||
there will be an executable application seperate from this package | ||
there will be an executable application separate from this package | ||
for Windows, Mac, and Linux users to effectively do the same thing | ||
as the above code block, but with a graphical user interface (GUI).* | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
""" | ||
# Creation Date: 08/30/2023 01:13 EDT | ||
# Last Updated Date: 02/24/2023 03:30 PM EST | ||
# Last Updated Date: 04/04/2024 05:10 PM EDT | ||
# Author: Joseph Armstrong ([email protected]) | ||
# File Name: betting.py | ||
# Purpose: Houses functions pertaining to betting data within the CFBD API. | ||
|
@@ -35,14 +35,14 @@ def get_cfbd_betting_lines( | |
return_as_dict: bool = False, | ||
): | ||
""" | ||
Retrives betting information from the CFBD API for a given season, | ||
Retrieves betting information from the CFBD API for a given season, | ||
or you could only get betting information for a single game. | ||
Parameters | ||
---------- | ||
`season` (int, mandatory): | ||
The season you want to retrive betting information from. | ||
The season you want to retrieve betting information from. | ||
`api_key` (str, optional): | ||
Semi-optional argument. | ||
|
@@ -66,7 +66,7 @@ def get_cfbd_betting_lines( | |
Optional argument. | ||
If `game_id` is set to a game ID, | ||
`get_cfb_betting_lines()` will try to get | ||
all betting informaiton for that game ID. | ||
all betting information for that game ID. | ||
`week` (int, optional): | ||
Optional argument. | ||
|
@@ -75,7 +75,7 @@ def get_cfbd_betting_lines( | |
`season_type` (str, semi-optional): | ||
Semi-optional argument. | ||
By defualt, this will be set to "regular", for the CFB regular season. | ||
By default, this will be set to "regular", for the CFB regular season. | ||
If you want postseason betting data, set `season_type` to "postseason". | ||
If `season_type` is set to anything but "regular" or "postseason", | ||
a `ValueError()` will be raised. | ||
|
@@ -105,9 +105,9 @@ def get_cfbd_betting_lines( | |
`conference` (str, optional): | ||
Optional argument. | ||
If you only want betting information from games | ||
involving teams a specific confrence, | ||
involving teams a specific conference, | ||
set `conference` to the abbreviation | ||
of the conference you want betting informaiton from. | ||
of the conference you want betting information from. | ||
`year` (int): | ||
Alternative keyword for `season` | ||
|
@@ -132,9 +132,9 @@ def get_cfbd_betting_lines( | |
from cfbd_json_py.betting import get_cfbd_betting_lines | ||
cfbd_key = "tigersAreAwsome" # placeholder for your CFBD API Key. | ||
cfbd_key = "tigersAreAwesome" # placeholder for your CFBD API Key. | ||
if cfbd_key is not "tigersAreAwsome": | ||
if cfbd_key is not "tigersAreAwesome": | ||
print( | ||
"Using the user's API key declared " + | ||
"in this script for this example." | ||
|
@@ -252,7 +252,7 @@ def get_cfbd_betting_lines( | |
# you could just call these functions directly, | ||
# without setting the API key in the script. | ||
print( | ||
"Using the user's API key suposedly loaded " + | ||
"Using the user's API key supposedly loaded " + | ||
"into this python environment for this example." | ||
) | ||
|
@@ -402,16 +402,6 @@ def get_cfbd_betting_lines( | |
elif away is not None: | ||
away_team = away | ||
|
||
# if conference is not None and conference is not None \ | ||
# and (conferenceis notconference): | ||
# raise ValueError( | ||
# "Inconsistent inputs for `conference` and `conference`."+ | ||
# "\nPlease use either `conference` OR `conference` "+ | ||
# "when calling this function" | ||
# ) | ||
# elif conference is not None: | ||
# conference = conference | ||
|
||
del year, home, away | ||
|
||
if game_id is not None and season is not None: | ||
|
@@ -439,7 +429,7 @@ def get_cfbd_betting_lines( | |
else: | ||
real_api_key = get_cfbd_api_token(api_key_dir=api_key_dir) | ||
|
||
if real_api_key == "tigersAreAwsome": | ||
if real_api_key == "tigersAreAwesome": | ||
raise ValueError( | ||
"You actually need to change `cfbd_key` to your CFBD API key." | ||
) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
""" | ||
# Creation Date: 08/30/2023 01:13 EDT | ||
# Last Updated Date: 02/24/2023 03:30 PM EST | ||
# Last Updated Date: 04/04/2024 05:10 PM EDT | ||
# Author: Joseph Armstrong ([email protected]) | ||
# File Name: coaches.py | ||
# Purpose: Houses functions pertaining to coaching data within the CFBD API. | ||
|
@@ -30,7 +30,7 @@ def get_cfbd_coaches_info( | |
return_as_dict: bool = False, | ||
): | ||
""" | ||
Retrives information from the CFBD API on CFB Head Coaches. | ||
Retrieves information from the CFBD API on CFB Head Coaches. | ||
Parameters | ||
---------- | ||
|
@@ -101,9 +101,9 @@ def get_cfbd_coaches_info( | |
from cfbd_json_py.coaches import get_cfbd_coaches_info | ||
cfbd_key = "tigersAreAwsome" # placeholder for your CFBD API Key. | ||
cfbd_key = "tigersAreAwesome" # placeholder for your CFBD API Key. | ||
if cfbd_key is not "tigersAreAwsome": | ||
if cfbd_key is not "tigersAreAwesome": | ||
print( | ||
"Using the user's API key declared in this script "+ | ||
"for this example." | ||
|
@@ -189,7 +189,7 @@ def get_cfbd_coaches_info( | |
# you could just call these functions directly, | ||
# without setting the API key in the script. | ||
print( | ||
"Using the user's API key suposedly loaded " + | ||
"Using the user's API key supposedly loaded " + | ||
"into this python environment for this example." | ||
) | ||
|
@@ -298,7 +298,7 @@ def get_cfbd_coaches_info( | |
else: | ||
real_api_key = get_cfbd_api_token(api_key_dir=api_key_dir) | ||
|
||
if real_api_key == "tigersAreAwsome": | ||
if real_api_key == "tigersAreAwesome": | ||
raise ValueError( | ||
"You actually need to change `cfbd_key` to your CFBD API key." | ||
) | ||
|
@@ -327,15 +327,15 @@ def get_cfbd_coaches_info( | |
logging.warning( | ||
"If you only want coaching information for a single season, " | ||
+ "and not for a range of seasons, only set `year` " | ||
+ "to the seaon you want coaching info for, " | ||
+ "to the season you want coaching info for, " | ||
+ "and leave `min_season` and `max_season` as `None` (NULL)." | ||
) | ||
min_season = None | ||
elif season is None: | ||
logging.warning( | ||
"If you only want coaching information for a single season, " | ||
+ "and not for a range of seasons, only set `year` to " | ||
+ "the seaon you want coaching info for, " | ||
+ "the season you want coaching info for, " | ||
+ "and leave `min_season` and `max_season` as `None` (NULL)." | ||
) | ||
season = min_season | ||
|
@@ -360,15 +360,15 @@ def get_cfbd_coaches_info( | |
logging.warning( | ||
"If you only want coaching information for " | ||
+ "a single season, and not for a range of seasons, " | ||
+ "only set `year` to the seaon you want coaching info for, " | ||
+ "only set `year` to the season you want coaching info for, " | ||
+ "and leave `min_season` and `max_season` as `None` (NULL)." | ||
) | ||
min_season = None | ||
elif season is None: | ||
logging.warning( | ||
"If you only want coaching information for " | ||
+ "a single season, and not for a range of seasons, " | ||
+ "only set `year` to the seaon you want coaching info for, " | ||
+ "only set `year` to the season you want coaching info for, " | ||
+ "and leave `min_season` and `max_season` as `None` (NULL)." | ||
) | ||
season = max_season | ||
|
Oops, something went wrong.