0.0.7: The "Infrastructure" Update.

- Implemented `cfbd_json_py.games.get_cfbd_games()`, a function that allows a user to get game/schedule data from the CFBD API.
- Added a Docs webpage framework to this package by using [pdoc](https://pdoc.dev/)
- Added `cfbd_json_py._early_access`, a section specifically for CFBD API endpoints that exist, but aren't implemented yet by this python package.
- Added python file descriptors to track changes, detail when a file was first created, and explian the python file's purpose.
- Implemented the `check_cfbd_api_compatability.py` python script, a script that checks if this python package is compatible with the most recent version of the CFBD API, and raises a `ValueError()` if that isn't the case.
- Updated the package version to `0.0.7`.

.github/workflows/check_cfbd_version.yml

@@ -0,0 +1,33 @@
+name: Check CFBD API Version
+on:
+  schedule:
+    - cron: "0 * * * *"
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install requests
+          python -m pip install bs4
+          python -m pip install lxml
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: run Python Script
+        run: |
+          python check_cfbd_api_compatability.py

.github/workflows/generate_docs.yml

@@ -0,0 +1,31 @@
+name: Generate Docs
+on:
+  schedule:
+    - cron: "0 0 * * 0"
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pdoc
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: run Python Script
+        run: |
+          python pdoc cfbd_json_py -o ./docs

CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG: cfbd_json_py
 
+## 0.0.8: The "Games" Update
+
+## 0.0.7: The "Infrastructure" Update.
+
+- Implemented `cfbd_json_py.games.get_cfbd_games()`, a function that allows a user to get game/schedule data from the CFBD API.
+- Added a Docs webpage framework to this package by using [pdoc](https://pdoc.dev/)
+- Added `cfbd_json_py._early_access`, a section specifically for CFBD API endpoints that exist, but aren't implemented yet by this python package.
+- Added python file descriptors to track changes, detail when a file was first created, and explian the python file's purpose.
+- Implemented the `check_cfbd_api_compatability.py` python script, a script that checks if this python package is compatible with the most recent version of the CFBD API, and raises a `ValueError()` if that isn't the case.
+- Updated the package version to `0.0.7`.
+
 ## 0.0.6: The "Drives" Update.
 
 - Implemented `cfbd_json_py.drives.get_cfbd_drives_info()`, a function that allows a user to get CFB drive data from the CFBD API.

cfbd_api_version.json

@@ -0,0 +1,3 @@
+{
+  "current_verson": "4.5.1"
+}

cfbd_json_py/__init__.py

@@ -1,5 +1,17 @@
-# Loaders
-# from cfbd_json_py.loaders import *
+# Creation Date: 08/30/2023 01:13 EDT
+# Last Updated Date: 10/06/2023 08:06 PM EDT
+# Author: Joseph Armstrong ([email protected])
+# File Name: __init__.py
+# Purpose: Allows for the python package to function,
+#          by allowing you to to access functions within
+#          this package.
+####################################################################################################
+
+# Generated Functions:
+from cfbd_json_py._early_access import *
+
+
+# Fully Implemented Functions:
 from cfbd_json_py.betting import *
 from cfbd_json_py.coaches import *
 from cfbd_json_py.conferences import *

cfbd_json_py/_early_access.py

@@ -0,0 +1,16 @@
+# Creation Date: 10/06/2023 07:33 PM EDT
+# Last Updated Date: 10/06/2023 08:00 PM EDT
+# Author: Joseph Armstrong ([email protected])
+# File Name: _early_access.py
+# Purpose: Houses functions that have yet to be implemented yet for the
+####################################################################################################
+
+
+def about_early_access_functions():
+    print(
+        "Early Access functions are functions generated by a generator script " +
+        "when an API endpoint is created, but not implemented yet by this python package."
+    )
+
+
+# TODO: Create a code generator if a function doesn't exist.

cfbd_json_py/betting.py

@@ -1,3 +1,9 @@
+# Creation Date: 08/30/2023 01:13 EDT
+# Last Updated Date: 10/06/2023 07:52 PM EDT
+# Author: Joseph Armstrong ([email protected])
+# File Name: betting.py
+# Purpose: Houses functions pertaining to betting data within the CFBD API.
+####################################################################################################
 
 import time
 import warnings

cfbd_json_py/coaches.py

@@ -1,3 +1,10 @@
+# Creation Date: 08/30/2023 01:13 EDT
+# Last Updated Date: 10/09/2023 08:00 PM EDT
+# Author: Joseph Armstrong ([email protected])
+# File Name: coaches.py
+# Purpose: Houses functions pertaining to coaching data within the CFBD API.
+####################################################################################################
+
 import logging
 import time
 

cfbd_json_py/conferences.py

@@ -1,3 +1,9 @@
+# Creation Date: 08/30/2023 01:13 EDT
+# Last Updated Date: 10/06/2023 07:35 PM EDT
+# Author: Joseph Armstrong ([email protected])
+# File Name: conferences.py
+# Purpose: Houses functions pertaining to CFB conference data within the CFBD API.
+####################################################################################################
 
 import time
 import pandas as pd