Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.2.0 The "Patreon" Update #43

Merged
merged 3 commits into from
Aug 13, 2024
Merged

0.2.0 The "Patreon" Update #43

merged 3 commits into from
Aug 13, 2024

Conversation

armstjc
Copy link
Owner

@armstjc armstjc commented Aug 13, 2024

  • Re-implemented the process of storing a user's API key. If you have used cfbd_json_py.utls.set_cfbd_api_token() in the past, you do not need to do anything to migrate your API key to this new process.
  • The following functions require a user to subscribe to the CFBD Patreon:
    • Implemented cfbd_json_py.games.get_cfbd_live_scoreboard(), a function that allows a user to get live scoreboard data directly from the CFBD API, if they subscribe to the CFBD patreon.
    • Implemented cfbd_json_py.games.get_cfbd_weather_info(), a function that allows a user to get weather data directly from the CFBD API, if they subscribe to the CFBD patreon.
    • Partially implemented cfbd_json_py.plays.get_cfbd_live_pbp_data(), a function that allows someone to access live play-by-play (PBP) data, if they subscribe to the CFBD patreon.
  • Implemented a new file header template for all python files.
  • Applied some minor formatting changes to the python code.
  • Updated the package version to 0.2.0, because of the new season (2024).

- Re-implemented the process of storing a user's API key. If you have used `cfbd_json_py.utls.set_cfbd_api_token()` in the past, you do not need to do anything to migrate your API key to this new process.
- The following functions require a user to subscribe to the [CFBD Patreon](https://www.patreon.com/collegefootballdata):
  - Implemented `cfbd_json_py.games.get_cfbd_live_scoreboard()`, a function that allows a user to get live scoreboard data directly from the CFBD API, if they subscribe to the CFBD patreon.
  - Implemented `cfbd_json_py.games.get_cfbd_weather_info()`, a function that allows a user to get weather data directly from the CFBD API, if they subscribe to the CFBD patreon.
  - Partially implemented `cfbd_json_py.plays.get_cfbd_live_pbp_data()`, a function that allows someone to access live play-by-play (PBP) data, if they subscribe to the CFBD patreon.
- Implemented a new file header template for all python files.
- Applied some minor formatting changes to the python code.
- Updated the package version to `0.2.0`, because of the new season (2024).
@armstjc armstjc self-assigned this Aug 13, 2024
Adding a `requirements.txt` file to fix a build issue found when attempting to generate the package's documentation webpage.
@armstjc armstjc merged commit 2052186 into main Aug 13, 2024
2 checks passed
@armstjc armstjc deleted the 0.2.0-The-Patreon-Update branch August 13, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement functions for endpoints that require a CFBD API Patreon subscription
1 participant