nhl-api-py 2.9.2__tar.gz → 2.10.2__tar.gz

{nhl_api_py-2.9.2 → nhl_api_py-2.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nhl-api-py
-Version: 2.9.2
+Version: 2.10.2
 Summary: NHL API (Updated for 2024/2025) and EDGE Stats.  For standings, team stats, outcomes, player information.  Contains each individual API endpoint as well as convience methods as well as pythonic query builder for more indepth EDGE stats.
 Home-page: https://github.com/coreyjs/nhl-api-py
 License: GPL-3.0-or-later
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 [![PyPI version](https://badge.fury.io/py/nhl-api-py.svg)](https://badge.fury.io/py/nhl-api-py)
 ![nhl-api-py workflow](https://github.com/coreyjs/nhl-api-py/actions/workflows/python-app.yml/badge.svg?branch=main)
 
-# NHL-API-PY
+# NHL API & NHL Edge Stats
 
 
 ## About
@@ -43,8 +43,9 @@ projects around the NHL and the NHL data sets.  Special thanks to https://github
 
 ### Developer Note: This is being updated with the new, also undocumented, NHL API.  
 
-More endpoints will be flushed out and completed as they
-are discovered. If you find any, open a ticket or post in the discussions tab.   I would love to hear more.
+As of 10/5/24 I seem to have a majority of the endpoints added from what I can tell, but every once and awhile I come across one that needs to be added/changed.  These will most likely be a minor ver bump.
+
+If you find any, open a ticket or post in the discussions tab.   I would love to hear more.
 
 
 ---
@@ -261,6 +262,8 @@ client.stats.club_stats_season(team_abbr="BUF") # kinda weird endpoint.
 
 client.stats.player_career_stats(player_id="8478402")
 
+client.stats.player_game_log(player_id="", season_id="20242025", game_type="2")
+
 # Team Summary Stats.
 #   These have lots of available parameters.  You can also tap into the apache cayenne expressions to build custom
 #   queries, if you have that knowledge.
@@ -270,8 +273,15 @@ client.stats.team_summary(start_season="20202021", end_season="20212022")
 
 # Skater Summary Stats.
 #   Queries for skaters for year ranges, filterable down by franchise.
-client.stats.skater_stats_summary(start_season="20232024", end_season="20232024")
-client.stats.skater_stats_summary(franchise_id=10, start_season="20232024", end_season="20232024")
+client.stats.skater_stats_summary_simple(start_season="20232024", end_season="20232024")
+client.stats.skater_stats_summary_simple(franchise_id=10, start_season="20232024", end_season="20232024")
+
+# For the following query context endpoints, see the above section
+client.stats.skater_stats_with_query_context(...)
+
+# Goalies
+client.stats.goalie_stats_summary_simple(start_season="20242025", stats_type="summary")
+
 ```
 ---
 

{nhl_api_py-2.9.2 → nhl_api_py-2.10.2}/README.md

@@ -1,7 +1,7 @@
 [![PyPI version](https://badge.fury.io/py/nhl-api-py.svg)](https://badge.fury.io/py/nhl-api-py)
 ![nhl-api-py workflow](https://github.com/coreyjs/nhl-api-py/actions/workflows/python-app.yml/badge.svg?branch=main)
 
-# NHL-API-PY
+# NHL API & NHL Edge Stats
 
 
 ## About
@@ -15,8 +15,9 @@ projects around the NHL and the NHL data sets.  Special thanks to https://github
 
 ### Developer Note: This is being updated with the new, also undocumented, NHL API.  
 
-More endpoints will be flushed out and completed as they
-are discovered. If you find any, open a ticket or post in the discussions tab.   I would love to hear more.
+As of 10/5/24 I seem to have a majority of the endpoints added from what I can tell, but every once and awhile I come across one that needs to be added/changed.  These will most likely be a minor ver bump.
+
+If you find any, open a ticket or post in the discussions tab.   I would love to hear more.
 
 
 ---
@@ -233,6 +234,8 @@ client.stats.club_stats_season(team_abbr="BUF") # kinda weird endpoint.
 
 client.stats.player_career_stats(player_id="8478402")
 
+client.stats.player_game_log(player_id="", season_id="20242025", game_type="2")
+
 # Team Summary Stats.
 #   These have lots of available parameters.  You can also tap into the apache cayenne expressions to build custom
 #   queries, if you have that knowledge.
@@ -242,8 +245,15 @@ client.stats.team_summary(start_season="20202021", end_season="20212022")
 
 # Skater Summary Stats.
 #   Queries for skaters for year ranges, filterable down by franchise.
-client.stats.skater_stats_summary(start_season="20232024", end_season="20232024")
-client.stats.skater_stats_summary(franchise_id=10, start_season="20232024", end_season="20232024")
+client.stats.skater_stats_summary_simple(start_season="20232024", end_season="20232024")
+client.stats.skater_stats_summary_simple(franchise_id=10, start_season="20232024", end_season="20232024")
+
+# For the following query context endpoints, see the above section
+client.stats.skater_stats_with_query_context(...)
+
+# Goalies
+client.stats.goalie_stats_summary_simple(start_season="20242025", stats_type="summary")
+
 ```
 ---
 

{nhl_api_py-2.9.2 → nhl_api_py-2.10.2}/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.9.2"
+__version__ = "2.10.2"

{nhl_api_py-2.9.2 → nhl_api_py-2.10.2}/nhlpy/api/stats.py

@@ -173,8 +173,8 @@ class Stats:
         default_cayenne_exp: str = None,
     ) -> List[dict]:
         """
-        Example: c.stats.skater_stats_summary(start_season="20232024", end_season="20232024")
-                 c.stats.skater_stats_summary(franchise_id=10, start_season="20232024", end_season="20232024")
+        Example: c.stats.skater_stats_summary_simple(start_season="20232024", end_season="20232024")
+                 c.stats.skater_stats_summary_simple(franchise_id=10, start_season="20232024", end_season="20232024")
         :param start_season: Season id, in format 20202021, 20212022, etc, that will be the start of the range.
         :param end_season: Season id for the end range.
         :param franchise_id: String, The ID of the franchise.  Not to be confused with team_id found on other endpoints.

nhl_api_py-2.10.2/nhlpy/api/teams.py

@@ -0,0 +1,70 @@
+from typing import List
+
+from nhlpy.http_client import HttpClient
+
+
+class Teams:
+    def __init__(self, http_client: HttpClient) -> None:
+        self.client = http_client
+        self.base_url = "https://api.nhle.com"
+        self.api_ver = "/stats/rest/"
+
+    def teams_info(self, date: str = "now") -> List[dict]:
+        """
+
+        :param date: Optional string, in format YYYY-MM-DD.  Defaults to "now".  So,
+        the NHL API sometimes uses the "now" string to default to the current date, but in some cases
+        such as preseaosn this is defaulting to last years season.  So, to get accurate teams for
+        this season, aka whatever year this is, you can supply the timestamp YYYY-MM-DD which should be the start
+        of the upcoming season.  For example, 2024-04-18 is for the season 2023-2025 and 2024-10-04 is for the season
+        2024-2025.
+
+        Returns a list of dicts with all the teams info.
+        Updated in 2.10.0, this pulls from current standings API, aggregates a list of teams
+        and their conf/div, joins it with franchise ID, and returns it.  This isnt pretty but
+        the NHL API has limitations to return this data in 1 request.
+        :return: dict
+        """
+        teams_info = self.client.get_by_url(full_resource=f"https://api-web.nhle.com/v1/standings/{date}").json()[
+            "standings"
+        ]
+        teams = []
+        for i in teams_info:
+            team = {
+                "conference": {"abbr": i["conferenceAbbrev"], "name": i["conferenceName"]},
+                "division": {"abbr": i["divisionAbbrev"], "name": i["divisionName"]},
+                "name": i["teamName"]["default"],
+                "common_name": i["teamCommonName"]["default"],
+                "abbr": i["teamAbbrev"]["default"],
+                "logo": i["teamLogo"],
+            }
+            teams.append(team)
+
+        # We also need to get "franchise_id", which is different than team_id.  This is used in the stats.
+        franchises = self.all_franchises()
+        for f in franchises:
+            for team in teams:
+                if "Canadiens" in f["fullName"] and "Canadiens" in team["name"]:
+                    team["franchise_id"] = f["id"]
+                    continue
+
+                if f["fullName"] == team["name"]:
+                    team["franchise_id"] = f["id"]
+
+        return teams
+
+    def roster(self, team_abbr: str, season: str) -> dict:
+        """
+        Returns the roster for the given team and season.
+        :param team_abbr: Team abbreviation.  BUF, TOR, etc
+        :param season: Season in format YYYYYYYY.  20202021, 20212022, etc
+        :return:
+        """
+        return self.client.get(resource=f"roster/{team_abbr}/{season}").json()
+
+    def all_franchises(self) -> List[dict]:
+        """
+        Returns a list of all past and current NHL franchises.  This includes ones long forgotten.
+        :return:
+        """
+        return self.client.get_by_url(full_resource="https://api.nhle.com/stats/rest/en/franchise").json()["data"]

{nhl_api_py-2.9.2 → nhl_api_py-2.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "nhl-api-py"
-version = "2.9.2"
+version = "2.10.2"
 description = "NHL API (Updated for 2024/2025) and EDGE Stats.  For standings, team stats, outcomes, player information.  Contains each individual API endpoint as well as convience methods as well as pythonic query builder for more indepth EDGE stats."
 authors = ["Corey Schaf <cschaf@gmail.com>"]
 readme = "README.md"

nhl_api_py-2.9.2/nhlpy/api/teams.py

@@ -1,49 +0,0 @@
-import json
-import importlib.resources
-from typing import List
-
-from nhlpy.http_client import HttpClient
-
-
-class Teams:
-    def __init__(self, http_client: HttpClient) -> None:
-        self.client = http_client
-        self.base_url = "https://api.nhle.com"
-        self.api_ver = "/stats/rest/"
-
-    def teams_info(self) -> dict:
-        """
-        Returns a list of dicts with all the teams info.  This is loaded via a harccoded json file.
-        :return: dict
-        """
-        data_resource = importlib.resources.files("nhlpy") / "data"
-        teams_info = json.loads((data_resource / "teams_20232024.json").read_text())["teams"]
-
-        # We also need to get "franchise_id", which is different than team_id.  This is used in the stats.
-        franchises = self.all_franchises()
-        for f in franchises:
-            for team in teams_info:
-                if "Canadiens" in f["fullName"] and "Canadiens" in team["name"]:
-                    team["franchise_id"] = f["id"]
-                    continue
-
-                if f["fullName"] == team["name"]:
-                    team["franchise_id"] = f["id"]
-
-        return teams_info
-
-    def roster(self, team_abbr: str, season: str) -> dict:
-        """
-        Returns the roster for the given team and season.
-        :param team_abbr: Team abbreviation.  BUF, TOR, etc
-        :param season: Season in format YYYYYYYY.  20202021, 20212022, etc
-        :return:
-        """
-        return self.client.get(resource=f"roster/{team_abbr}/{season}").json()
-
-    def all_franchises(self) -> List[dict]:
-        """
-        Returns a list of all past and current NHL franchises.  This includes ones long forgotten.
-        :return:
-        """
-        return self.client.get_by_url(full_resource="https://api.nhle.com/stats/rest/en/franchise").json()["data"]