nhl-api-py 2.3.4__tar.gz → 2.5.0__tar.gz

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nhl-api-py
-Version: 2.3.4
+Version: 2.5.0
 Summary: NHL API.  For standings, team stats, outcomes, player information.  Contains each individual API endpoint as well as convience methods for easy data loading in Pandas or any ML applications.
 Home-page: https://github.com/coreyjs/nhl-api-py
 License: GPL-3.0-or-later
@@ -59,8 +59,10 @@ Im available on [Bluesky](https://bsky.app/profile/coreyjs.dev) for any question
 from nhlpy import NHLClient
 
 client = NHLClient()
-# OR
-client = NHLClient(verbose=True) # a tad more logging such as the URL being called
+# Fore more verbose logging
+client = NHLClient(verbose=True)
+# OR Other available configurations:
+client = NHLClient(verbose={bool}, timeout={int}, ssl_verify={bool}, follow_redirects={bool})
 ```
 ---
 ## Stats with QueryBuilder

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/README.md

@@ -32,8 +32,10 @@ Im available on [Bluesky](https://bsky.app/profile/coreyjs.dev) for any question
 from nhlpy import NHLClient
 
 client = NHLClient()
-# OR
-client = NHLClient(verbose=True) # a tad more logging such as the URL being called
+# Fore more verbose logging
+client = NHLClient(verbose=True)
+# OR Other available configurations:
+client = NHLClient(verbose={bool}, timeout={int}, ssl_verify={bool}, follow_redirects={bool})
 ```
 ---
 ## Stats with QueryBuilder

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/nhlpy/_version.py

@@ -1,3 +1,3 @@
 # Should this be driven by the main pyproject.toml file? yes, is it super convoluted? yes, can it wait? sure
 
-__version__ = "2.3.4"
+__version__ = "2.5.0"

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/nhlpy/api/game_center.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, List
 from nhlpy.http_client import HttpClient
 
 
@@ -43,3 +43,18 @@ class GameCenter:
         :return: dict
         """
         return self.client.get(resource=f"score/{date if date else 'now'}").json()
+
+    def shift_chart_data(self, game_id: str, excludes: List[str] = None) -> dict:
+        """
+        Get shift chart data for the game_id.  GameIds can be retrieved from the schedule endpoint.
+        :param excludes: List of strings of items to exclude from the response.
+        :param game_id: The game_id for the game you want the shift chart data for.
+        :return: dict
+        """
+        if not excludes:
+            excludes = ["eventDetails"]
+
+        base_url: str = "https://api.nhle.com/stats/rest/en/shiftcharts"
+        exclude_p: str = ",".join(excludes)
+        expr_p: str = f"gameId={game_id} and ((duration != '00:00' and typeCode = 517) or typeCode != 517 )"
+        return self.client.get_by_url(full_resource=f"{base_url}?cayenneExp={expr_p}&exclude={exclude_p}").json()

nhl_api_py-2.5.0/nhlpy/config.py

@@ -0,0 +1,12 @@
+class ClientConfig:
+    def __init__(
+        self, verbose: bool = False, timeout: int = 10, ssl_verify: bool = True, follow_redirects: bool = True
+    ) -> None:
+        self.verbose = verbose
+        self.timeout = timeout
+        self.ssl_verify = ssl_verify
+        self.follow_redirects = follow_redirects
+
+        self.api_web_base_url = "https://api-web.nhle.com"
+        self.api_base_url = "https://api.nhle.com"
+        self.api_web_api_ver = "/v1/"

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/nhlpy/http_client.py

@@ -14,9 +14,10 @@ class HttpClient:
         :param resource:
         :return:
         """
-        r: httpx.request = httpx.get(
-            url=f"{self._config.api_web_base_url}{self._config.api_web_api_ver}{resource}", follow_redirects=True
-        )
+        with httpx.Client(
+            verify=self._config.ssl_verify, timeout=self._config.timeout, follow_redirects=self._config.follow_redirects
+        ) as client:
+            r: httpx.request = client.get(url=f"{self._config.api_web_base_url}{self._config.api_web_api_ver}{resource}")
 
         if self._config.verbose:
             logging.info(f"API URL: {r.url}")
@@ -30,7 +31,10 @@ class HttpClient:
         :param full_resource:  The full resource to get.
         :return:
         """
-        r: httpx.request = httpx.get(url=full_resource, params=query_params, follow_redirects=True)
+        with httpx.Client(
+            verify=self._config.ssl_verify, timeout=self._config.timeout, follow_redirects=self._config.follow_redirects
+        ) as client:
+            r: httpx.request = client.get(url=full_resource, params=query_params)
 
         if self._config.verbose:
             logging.info(f"API URL: {r.url}")

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/nhlpy/nhl_client.py

@@ -13,11 +13,20 @@ class NHLClient:
         client = NHLClient(verbose=True) # for a lil extra logging
     """
 
-    def __init__(self, verbose: bool = False) -> None:
+    def __init__(
+        self, verbose: bool = False, timeout: int = 10, ssl_verify: bool = True, follow_redirects: bool = True
+    ) -> None:
         """
-        param: verbose:  If True, will print out the URL of the API call.
+        :param follow_redirects: bool.  Some of these endpoints use redirects (ew).  This is the case when using
+        endpoints that use "/now" in them, which will redirect to todays data.
+        :param verbose: bool, Defaults to False.  Set to True for extra logging.
+        :param timeout: int, Defaults to 10 seconds.
+        :param ssl_verify: bool, Defaults to True.  Set to false if you want to ignore SSL verification.
         """
-        self._config = ClientConfig(verbose=verbose)
+        # This config type setup isnt doing what I thought it would.  This will be reworked later on.
+        self._config = ClientConfig(
+            verbose=verbose, timeout=timeout, ssl_verify=ssl_verify, follow_redirects=follow_redirects
+        )
         self._http_client = HttpClient(self._config)
 
         self.teams = teams.Teams(http_client=self._http_client)

{nhl_api_py-2.3.4 → nhl_api_py-2.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "nhl-api-py"
-version = "2.3.4"
+version = "2.5.0"
 description = "NHL API.  For standings, team stats, outcomes, player information.  Contains each individual API endpoint as well as convience methods for easy data loading in Pandas or any ML applications."
 authors = ["Corey Schaf <cschaf@gmail.com>"]
 readme = "README.md"

nhl_api_py-2.3.4/nhlpy/config.py

@@ -1,6 +0,0 @@
-class ClientConfig:
-    def __init__(self, verbose: bool = False) -> None:
-        self.verbose = verbose
-        self.api_web_base_url = "https://api-web.nhle.com"
-        self.api_base_url = "https://api.nhle.com"
-        self.api_web_api_ver = "/v1/"