nbastatpy 0.1.6__tar.gz

nbastatpy-0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aberghammer-analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nbastatpy-0.1.6/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: nbastatpy
+Version: 0.1.6
+Summary: An easy-to-use wrapper for nba_api to easily find data for a player, game, team, or season
+Home-page: https://github.com/aberghammer-analytics/NBAStatPy
+Keywords: basketball,data,nba,sports,stats
+Maintainer: Anthony Berghammer
+Maintainer-email: aberghammer.analytics@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: bs4 (>=0.0.2,<0.0.3)
+Requires-Dist: loguru (>=0.7.2,<0.8.0)
+Requires-Dist: nba_api (>=1.4.1,<2.0.0)
+Requires-Dist: pandas (>=2.2.2,<3.0.0)
+Requires-Dist: pillow (>=10.3.0,<11.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Project-URL: Documentation, https://github.com/aberghammer-analytics/NBAStatPy/blob/main/README.md
+Project-URL: Repository, https://github.com/aberghammer-analytics/NBAStatPy
+Description-Content-Type: text/markdown
+
+# NBAStatPy
+
+## Overview
+
+This is an easy-to-use wrapper for the `nba_api` package. The goal is to be able to easily access and find data for a player, game, team, or season. 
+
+The data is accessed through a class based on how you're searching for it. A quickstart example is shown below. Currently there are 4 classes:
+
+- `Game`
+- `Player`
+- `Season`
+- `Team`
+
+## Quickstart
+
+To get started you can import the class that represents the data you're searching for.
+
+```{python}
+from nbastatpy.player import Player
+```
+
+Then you build a player using either an ID from stats.nba.com or the player's name. When you're building the player object you can add additional search data like season, data format, or playoffs vs. regular season.
+
+```{python}
+player = Player(
+    "Giannis", 
+    season="2020", 
+    playoffs=True,
+    permode="PerGame"
+)
+```
+
+Once you have the player object, you can get different datasets based on the criteria. For instance, you can get the awards the player has won by doing the following:
+
+```{python}
+player.get_awards()
+```
+
+This returns a pandas dataframe with the awards won by the player each year.
+
+There are a lot of endpoints and various arguments for more complex queries like tracking and synergy datasets.
+

nbastatpy-0.1.6/README.md

@@ -0,0 +1,41 @@
+# NBAStatPy
+
+## Overview
+
+This is an easy-to-use wrapper for the `nba_api` package. The goal is to be able to easily access and find data for a player, game, team, or season. 
+
+The data is accessed through a class based on how you're searching for it. A quickstart example is shown below. Currently there are 4 classes:
+
+- `Game`
+- `Player`
+- `Season`
+- `Team`
+
+## Quickstart
+
+To get started you can import the class that represents the data you're searching for.
+
+```{python}
+from nbastatpy.player import Player
+```
+
+Then you build a player using either an ID from stats.nba.com or the player's name. When you're building the player object you can add additional search data like season, data format, or playoffs vs. regular season.
+
+```{python}
+player = Player(
+    "Giannis", 
+    season="2020", 
+    playoffs=True,
+    permode="PerGame"
+)
+```
+
+Once you have the player object, you can get different datasets based on the criteria. For instance, you can get the awards the player has won by doing the following:
+
+```{python}
+player.get_awards()
+```
+
+This returns a pandas dataframe with the awards won by the player each year.
+
+There are a lot of endpoints and various arguments for more complex queries like tracking and synergy datasets.

nbastatpy-0.1.6/pyproject.toml

@@ -0,0 +1,36 @@
+[tool.poetry]
+name = "nbastatpy"
+version = "0.1.6"
+description = "An easy-to-use wrapper for nba_api to easily find data for a player, game, team, or season"
+authors = []
+maintainers = ["Anthony Berghammer <aberghammer.analytics@gmail.com>"]
+readme = "README.md"
+repository = "https://github.com/aberghammer-analytics/NBAStatPy"
+documentation = "https://github.com/aberghammer-analytics/NBAStatPy/blob/main/README.md"
+keywords = ["basketball", "data", "nba", "sports", "stats"]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+]
+exclude = [
+    ".scratch/",
+    ".venv/",
+    ".vscode",
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+pandas = "^2.2.2"
+nba_api = "^1.4.1"
+pillow = "^10.3.0"
+requests = "^2.31.0"
+loguru = "^0.7.2"
+rich = "^13.7.1"
+bs4 = "^0.0.2"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.4.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

nbastatpy-0.1.6/src/nbastatpy/__init__.py

@@ -0,0 +1 @@
+name = "nbastatpy"

nbastatpy-0.1.6/src/nbastatpy/game.py

@@ -0,0 +1,153 @@
+from typing import List
+
+import nba_api.stats.endpoints as nba
+import pandas as pd
+
+from nbastatpy.utils import Formatter
+
+
+class Game:
+    def __init__(self, game_id: str):
+        """This represents a game.  Given an ID, you can get boxscore (and other) information through one of the 'get' methods
+
+        Args:
+            game_id (str): string with 10 digits
+        """
+        self.game_id = Formatter.format_game_id(game_id)
+
+    def get_boxscore(self) -> List[pd.DataFrame]:
+        """Gets traditional boxscore
+
+        Returns:
+            List[pd.DataFrame]: list of dataframes (players, starters/bench, team)
+        """
+        self.boxscore = nba.BoxScoreTraditionalV3(self.game_id).get_data_frames()
+        return self.boxscore
+
+    def get_advanced(self):
+        """
+        Retrieves the advanced box score data for the game.
+
+        Returns:
+            pandas.DataFrame: The advanced box score data for the game.
+        """
+        self.adv_box = nba.BoxScoreAdvancedV3(self.game_id).get_data_frames()
+        return self.adv_box
+
+    def get_defense(self):
+        """
+        Retrieves the defensive statistics for the game.
+
+        Returns:
+            def_box (pandas.DataFrame): DataFrame containing the defensive statistics.
+        """
+        self.def_box = nba.BoxScoreDefensiveV2(self.game_id).get_data_frames()
+        return self.def_box
+
+    def get_four_factors(self):
+        """
+        Retrieves the four factors data for the game.
+
+        Returns:
+            pandas.DataFrame: The four factors data for the game.
+        """
+        self.four_factors = nba.BoxScoreFourFactorsV3(self.game_id).get_data_frames()
+        return self.four_factors
+
+    def get_hustle(self) -> List[pd.DataFrame]:
+        """Gets hustle data for a given game
+
+        Returns:
+            List[pd.DataFrame]: list of two dataframes (players, teams)
+        """
+        self.hustle = nba.BoxScoreHustleV2(self.game_id).get_data_frames()
+        return self.hustle
+
+    def get_matchups(self):
+        """
+        Retrieves the matchups for the game.
+
+        Returns:
+            pandas.DataFrame: The matchups data for the game.
+        """
+        self.matchups = nba.BoxScoreMatchupsV3(self.game_id).get_data_frames()
+        return self.matchups
+
+    def get_misc(self):
+        """
+        Retrieves miscellaneous box score data for the game.
+
+        Returns:
+            pandas.DataFrame: The miscellaneous box score data.
+        """
+        self.misc = nba.BoxScoreMiscV3(self.game_id).get_data_frames()
+        return self.misc
+
+    def get_scoring(self):
+        """
+        Retrieves the scoring data for the game.
+
+        Returns:
+            pandas.DataFrame: The scoring data for the game.
+        """
+        self.scoring = nba.BoxScoreScoringV3(self.game_id).get_data_frames()
+        return self.scoring
+
+    def get_usage(self) -> List[pd.DataFrame]:
+        """Gets usage data for a given game
+
+        Returns:
+            List[pd.DataFrame]: list of two dataframes (players, teams)
+        """
+        self.usage = nba.BoxScoreUsageV3(self.game_id).get_data_frames()
+        return self.usage
+
+    def get_playertrack(self):
+        """
+        Retrieves the player tracking data for the game.
+
+        Returns:
+            playertrack (pandas.DataFrame): The player tracking data for the game.
+        """
+        self.playertrack = nba.BoxScorePlayerTrackV3(self.game_id).get_data_frames()
+        return self.playertrack
+
+    def get_rotations(self):
+        """
+        Retrieves the rotations data for the game.
+
+        Returns:
+            pandas.DataFrame: The rotations data for the game.
+        """
+        self.rotations = pd.concat(
+            nba.GameRotation(game_id=self.game_id).get_data_frames()
+        )
+        return self.rotations
+
+    def get_playbyplay(self) -> pd.DataFrame:
+        """
+        Retrieves the play-by-play data for the game.
+
+        Returns:
+            pd.DataFrame: The play-by-play data as a pandas DataFrame.
+        """
+        self.playbyplay = nba.PlayByPlayV3(self.game_id).get_data_frames()[0]
+        return self.playbyplay
+
+    def get_win_probability(self) -> pd.DataFrame:
+        """
+        Retrieves the win probability data for the game.
+
+        Returns:
+            pd.DataFrame: The win probability data as a pandas DataFrame.
+        """
+        self.win_probability = nba.WinProbabilityPBP(
+            game_id=self.game_id
+        ).get_data_frames()[0]
+        return self.win_probability
+
+
+if __name__ == "__main__":
+    GAME_ID = "0022301148"
+    game = Game(game_id=GAME_ID)
+    print(game.get_win_probability())