nbastatpy 0.1.6__py3-none-any.whl

nbastatpy/team.py

@@ -0,0 +1,436 @@
+from typing import List
+
+import nba_api.stats.endpoints as nba
+import pandas as pd
+import requests
+from bs4 import BeautifulSoup
+from nba_api.stats.static import teams
+
+from nbastatpy.utils import Formatter, PlayTypes
+
+
+class Team:
+    def __init__(
+            self,
+            team_abbreviation: str,
+            season_year: str = None,
+            playoffs=False,
+            permode: str = "PerGame",
+        ):
+        """
+        Initializes a Team object.
+
+        Parameters:
+        - team_abbreviation (str): The abbreviation of the NBA team.
+        - season_year (str, optional): The season year. If not provided, the current season year will be used.
+        - playoffs (bool, optional): Specifies whether the team's statistics are for playoffs. Default is False.
+        - permode (str, optional): The mode for the team's statistics. Default is "PerGame".
+
+        Attributes:
+        - permode (str): The formatted permode for the team's statistics.
+        - season_year (str): The season year.
+        - info (dict): The information about the team.
+        - season (str): The formatted season.
+        - season_type (str): The type of season (Regular Season or Playoffs).
+        """
+        self.permode = PlayTypes.PERMODE[
+            permode.replace("_", "").replace("-", "").upper()
+        ]
+        if season_year:
+            self.season_year = season_year
+        else:
+            self.season_year = Formatter.get_current_season_year()
+
+        self.info = teams.find_team_by_abbreviation(team_abbreviation)
+
+        self.season = Formatter.format_season(self.season_year)
+        self.season_type = "Regular Season"
+        if playoffs:
+            self.season_type = "Playoffs"
+
+        for attr_name, value in self.info.items():
+            setattr(self, attr_name.lower(), self.info.get(attr_name, None))
+
+    def get_logo(self):
+        """
+        Retrieves and returns the logo of the NBA team in svg format.
+
+        Returns:
+            PIL.Image.Image: The logo image of the NBA team.
+        """
+        pic_url = f"https://cdn.nba.com/logos/nba/{self.id}/primary/L/logo.svg"
+        pic = requests.get(pic_url)
+        self.logo = pic.content
+        return self.logo
+
+    def get_roster(self) -> List[pd.DataFrame]:
+        """
+        Retrieves the roster of the team for the specified season.
+
+        Returns:
+            List[pd.DataFrame]: A list of pandas DataFrames containing the roster data.
+        """
+        self.roster = nba.CommonTeamRoster(
+            self.id,
+            season=self.season,
+        ).get_data_frames()
+        return self.roster
+
+    def get_salary(self) -> pd.DataFrame:
+        """
+        Retrieves the salary information for the team from hoopshype.com.
+
+        Returns:
+            pandas.DataFrame: A DataFrame containing the salary information for the team.
+        """
+        tm_name = "_".join(self.full_name.split(" ")).lower()
+        year = self.season.split("-")[0]
+        season_string = year + "-" + str(int(year) + 1)
+        self.salary_url = f"https://hoopshype.com/salaries/{tm_name}/{season_string}/"
+
+        result = requests.get(self.salary_url)
+        soup = BeautifulSoup(result.content, features="html.parser")
+        tables = soup.find_all("table")
+        
+        rows = [[cell.text.strip() for cell in row.find_all('td')] for row in tables[0].find_all('tr')]
+        
+        if not rows[0]:
+            rows.pop(0)
+            if not rows:
+                raise(ValueError(f"Season data unavailable for: {season_string}"))
+        self.salary_df = pd.DataFrame(rows[1:], columns=rows[0])
+        self.salary_df["Season"] = self.salary_df.columns[1].replace("/", "_")
+        self.salary_df.columns = ["Player", "Salary", "Adjusted Salary", "Season"]
+
+        return self.salary_df
+
+    def get_year_by_year(self) -> pd.DataFrame:
+        """
+        Retrieves the year-by-year statistics for the team.
+
+        Returns:
+            pd.DataFrame: The year-by-year statistics for the team.
+        """
+        self.year_by_year = nba.TeamYearByYearStats(
+            team_id=self.id, per_mode_simple=self.permode
+        ).get_data_frames()[0]
+        return self.year_by_year
+
+    def get_general_splits(self) -> pd.DataFrame:
+        """
+        Retrieves the general splits data for the team.
+
+        Returns:
+            pd.DataFrame: The general splits data for the team.
+        """
+        drop_cols = [
+            "TEAM_GAME_LOCATION",
+            "GAME_RESULT",
+            "SEASON_MONTH_NAME",
+            "SEASON_SEGMENT",
+            "TEAM_DAYS_REST_RANGE",
+        ]
+        self.general_splits = pd.concat(
+            nba.TeamDashboardByGeneralSplits(
+                team_id=self.id,
+                season=self.season,
+                season_type_all_star=self.season_type,
+                per_mode_detailed=self.permode,
+            ).get_data_frames()
+        ).drop(columns=drop_cols)
+        return self.general_splits
+
+    def get_shooting_splits(self) -> pd.DataFrame:
+        """
+        Retrieves shooting splits data for the team.
+
+        Returns:
+            pd.DataFrame: The shooting splits data for the team.
+        """
+        self.shooting_splits = pd.concat(
+            nba.TeamDashboardByShootingSplits(
+                team_id=self.id,
+                season=self.season,
+                season_type_all_star=self.season_type,
+                per_mode_detailed=self.permode,
+            ).get_data_frames()
+        )
+        return self.shooting_splits
+
+    def get_leaders(self) -> pd.DataFrame:
+        """
+        Retrieves the franchise leaders data for the team.
+
+        Returns:
+            pd.DataFrame: The franchise leaders data for the team.
+        """
+        self.leaders = nba.FranchiseLeaders(team_id=self.id).get_data_frames()[0]
+        return self.leaders
+
+    def get_franchise_players(self) -> pd.DataFrame:
+        """
+        Retrieves the franchise players for the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the franchise players' data.
+        """
+        self.franchise_players = nba.FranchisePlayers(
+            team_id=self.id
+        ).get_data_frames()[0]
+        return self.franchise_players
+
+    def get_season_lineups(self) -> pd.DataFrame:
+        """
+        Retrieves the season lineups for the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the season lineups data.
+        """
+        self.season_lineups = nba.LeagueDashLineups(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.season_lineups["season"] = self.season
+        self.season_lineups["season_type"] = self.season_type
+
+        return self.season_lineups
+
+    def get_opponent_shooting(self) -> pd.DataFrame:
+        """
+        Retrieves the opponent shooting statistics for the team.
+
+        Returns:
+            pd.DataFrame: DataFrame containing the opponent shooting statistics.
+        """
+        self.opponent_shooting = nba.LeagueDashOppPtShot(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_simple=self.permode,
+        ).get_data_frames()[0]
+        self.opponent_shooting["season"] = self.season
+        self.opponent_shooting["season_type"] = self.season_type
+
+        return self.opponent_shooting
+
+    def get_player_clutch(self) -> pd.DataFrame:
+        """
+        Retrieves the clutch statistics for the players of the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the clutch statistics for the players of the team.
+        """
+        self.player_clutch = nba.LeagueDashPlayerClutch(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.player_clutch["season"] = self.season
+        self.player_clutch["season_type"] = self.season_type
+
+        return self.player_clutch
+
+    def get_player_shots(self) -> pd.DataFrame:
+        """
+        Retrieves the player shots data for the team.
+
+        Returns:
+            pd.DataFrame: The player shots data for the team.
+        """
+        self.player_shots = nba.LeagueDashPlayerPtShot(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_simple=self.permode,
+        ).get_data_frames()[0]
+        self.player_shots["season"] = self.season
+        self.player_shots["season_type"] = self.season_type
+
+        return self.player_shots
+
+    def get_player_shot_locations(self) -> pd.DataFrame:
+        """
+        Retrieves the shot locations data for the players of the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the shot locations data for the players.
+        """
+        self.player_shot_locations = nba.LeagueDashPlayerShotLocations(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.player_shot_locations["season"] = self.season
+        self.player_shot_locations["season_type"] = self.season_type
+
+        return self.player_shot_locations
+
+    def get_player_stats(self) -> pd.DataFrame:
+        """
+        Retrieves the player statistics for the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the player statistics.
+        """
+        self.player_stats = nba.LeagueDashPlayerStats(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.player_stats["season"] = self.season
+        self.player_stats["season_type"] = self.season_type
+
+        return self.player_stats
+
+    def get_player_point_defend(self) -> pd.DataFrame:
+        """
+        Retrieves the player point defense data for the team.
+
+        Returns:
+            pd.DataFrame: The player point defense data for the team.
+        """
+        self.player_point_defend = nba.LeagueDashPtDefend(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_simple=self.permode,
+        ).get_data_frames()[0]
+        self.player_point_defend["season"] = self.season
+        self.player_point_defend["season_type"] = self.season_type
+
+        return self.player_point_defend
+
+    def get_player_hustle(self) -> pd.DataFrame:
+        """
+        Retrieves the hustle stats for the players of the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the hustle stats for the players.
+        """
+        self.player_hustle = nba.LeagueHustleStatsPlayer(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+        ).get_data_frames()[0]
+        self.player_hustle["season"] = self.season
+        self.player_hustle["season_type"] = self.season_type
+
+        return self.player_hustle
+
+    def get_lineup_details(self) -> pd.DataFrame:
+        """
+        Retrieves the lineup details for the team.
+
+        Returns:
+            pd.DataFrame: The lineup details for the team.
+        """
+        self.lineup_details = nba.LeagueLineupViz(
+            team_id_nullable=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            minutes_min=1,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.lineup_details["season"] = self.season
+        self.lineup_details["season_type"] = self.season_type
+
+        return self.lineup_details
+
+    def get_player_on_details(self) -> pd.DataFrame:
+        """
+        Retrieves the player on-court details for the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the player on-court details.
+        """
+        self.player_on_details = nba.LeaguePlayerOnDetails(
+            team_id=self.id,
+            season=self.season,
+            season_type_all_star=self.season_type,
+            per_mode_detailed=self.permode,
+        ).get_data_frames()[0]
+        self.player_on_details["season"] = self.season
+        self.player_on_details["season_type"] = self.season_type
+
+        return self.player_on_details
+
+    def get_player_matchups(self, defense=False) -> pd.DataFrame:
+        """
+        Retrieves player matchups for the team.
+
+        Args:
+            defense (bool, optional): If True, retrieves defensive matchups. If False, retrieves offensive matchups. Defaults to False.
+
+        Returns:
+            pd.DataFrame: DataFrame containing player matchups for the team.
+        """
+        if defense:
+            self.player_matchups = nba.LeagueSeasonMatchups(
+                def_team_id_nullable=self.id,
+                season=self.season,
+                season_type_playoffs=self.season_type,
+                per_mode_simple=self.permode,
+            ).get_data_frames()[0]
+        else:
+            self.player_matchups = nba.LeagueSeasonMatchups(
+                off_team_id_nullable=self.id,
+                season=self.season,
+                season_type_playoffs=self.season_type,
+                per_mode_simple=self.permode,
+            ).get_data_frames()[0]
+
+        self.player_matchups["season"] = self.season
+        self.player_matchups["season_type"] = self.season_type
+
+        return self.player_matchups
+
+    def get_player_passes(self) -> pd.DataFrame:
+        """
+        Retrieves the player passes data for the team.
+
+        Returns:
+            pd.DataFrame: The player passes data for the team.
+        """
+        self.player_passes = pd.concat(
+            nba.TeamDashPtPass(
+                team_id=self.id,
+                season=self.season,
+                season_type_all_star=self.season_type,
+                per_mode_simple=self.permode,
+            ).get_data_frames()
+        )
+
+        group_cols = ["PASS_FROM", "PASS_TO"]
+        self.player_passes["GROUP_SET"] = self.player_passes[group_cols].apply(
+            Formatter.combine_strings, axis=1
+        )
+        self.player_passes = self.player_passes.drop(columns=group_cols)
+        return self.player_passes.reset_index(drop=True)
+
+    def get_player_onoff(self) -> pd.DataFrame:
+        """
+        Retrieves the on-off court details for the players of the team.
+
+        Returns:
+            pd.DataFrame: A DataFrame containing the on-off court details for the players.
+        """
+        self.player_onoff = pd.concat(
+            nba.TeamPlayerOnOffDetails(
+                team_id=team.id,
+                season=self.season,
+                season_type_all_star=self.season_type,
+                per_mode_detailed=self.permode,
+            ).get_data_frames()[1:]
+        )
+        return self.player_onoff.reset_index(drop=True)
+
+
+if __name__ == "__main__":
+    team_name = "MIL"
+    team = Team(team_name, season_year="2024", playoffs=True)
+    print(team.get_salary())

nbastatpy/utils.py

@@ -0,0 +1,98 @@
+from datetime import datetime
+
+import pandas as pd
+
+
+class PlayTypes:
+
+    PERMODE = {
+        "PERGAME": "PerGame",
+        "PER36": "Per36",
+        "TOTALS": "Totals",
+        "PERMINUTE": "PerMinute",
+        "PERMIN": "PerMinute",
+        "PERPOSSESSION": "Per100Possessions",
+        "PERPOSS": "Per100Possessions",
+        "PER100POSSESSIONS": "Per100Possessions",
+        "PERPLAY": "PerPlay",
+        "PER100PLAYS": "Per100Plays",
+    }
+
+    PLAYTYPES = {
+        "TRANSITION": "Transition",
+        "ISOLATION": "Isolation",
+        "ISO": "Isolation",
+        "PRBALLHANDLER": "PRBallHandler",
+        "PRROLLMAN": "PRRollman",
+        "POSTUP": "Postup",
+        "SPOTUP": "Spotup",
+        "HANDOFF": "Handoff",
+        "CUT": "Cut",
+        "OFFSCREEN": "OffScreen",
+        "PUTBACKS": "OffRebound",
+        "OFFREBOUND": "OffRebound",
+        "MISC": "Misc",
+    }
+
+    TRACKING_TYPES = {
+        "SPEEDDISTANCE": "SpeedDistance",
+        "SPEED": "SpeedDistance",
+        "DISTANCE": "SpeedDistance",
+        "POSSESSIONS": "Possessions",
+        "CATCHSHOOT": "CatchShoot",
+        "PULLUPSHOT": "PullUpShot",
+        "PULLUP": "PullUpShot",
+        "DEFENSE": "Defense",
+        "DRIVES": "Drives",
+        "DRIVE": "Drives",
+        "PASSING": "Passing",
+        "ELBOWTOUCH": "ElbowTouch",
+        "ELBOW": "ElbowTouch",
+        "POSTTOUCH": "PostTouch",
+        "POST": "PostTouch",
+        "PAINTTOUCH": "PaintTouch",
+        "PAINT": "PaintTouch",
+        "EFFICIENCY": "Efficiency",
+    }
+
+    DEFENSE_TYPES = {
+        "OVERALL": "Overall",
+        "THREE": "3 Pointers",
+        "THREES": "3 Pointers",
+        "TWOS": "2 Pointers",
+        "TWO": "2 Pointers",
+        "LESSTHAN6FT": "Less Than 6Ft",
+        "LESSTHAN10FT": "Less Than 10Ft",
+        "GREATERTHAN15FT": "Greater Than 15Ft",
+    }
+
+
+class Formatter:
+
+    def get_current_season_year() -> str:
+        current_datetime = datetime.now()
+        current_season_year = current_datetime.year
+        if current_datetime.month <= 9:
+            current_season_year -= 1
+        return current_season_year
+
+    def format_season(season_year: int) -> str:
+        return "{}-{}".format(int(season_year), str(int(season_year) + 1)[2:])
+
+    def format_game_id(game_id) -> str:
+        return str(game_id).zfill(10)
+
+    def combine_strings(row) -> str:
+        return next(value for value in row if pd.notna(value))
+
+    def check_playtype(play: str, playtypes: dict) -> str:
+
+        play = play.replace("_", "").replace("-", "").upper()
+
+        if play == "ALL":
+            return list(set(playtypes.values()))
+
+        if play not in set(playtypes.keys()):
+            raise ValueError(f"Playtype: {play} not found")
+
+        return playtypes[play]

nbastatpy-0.1.6.dist-info/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,10 @@
+nbastatpy/__init__.py,sha256=LhTkEQMCuJU5UMrQliKi4z3HtuMxxDY5_79ZJ0IB5PU,18
+nbastatpy/game.py,sha256=RSUgATPk6xBj6kFqtQ74IfnjdwMUuRhaZWEflO84Qjk,4631
+nbastatpy/player.py,sha256=NHa0WTuw9301mfPSSsXTWg87_xGS8GjP1Fh1JYkTK8s,17311
+nbastatpy/season.py,sha256=0zEWb_iBcsKe42wsU9ISxbUl6HU2Tbt1DISRJXFyj_A,19732
+nbastatpy/team.py,sha256=gjjIJc4JoYAjmJII9Mw1FDrDMl0AJjFMgVeIEvPnNNg,15250
+nbastatpy/utils.py,sha256=mFH1SqQUWR_Vpl154urgvOZWf5HtflIrlj1eGNzhCeY,2739
+nbastatpy-0.1.6.dist-info/LICENSE,sha256=TZeVWgOOMmZI_Puv-mvmD8h35JL78SyVE5A6JVISLV0,1078
+nbastatpy-0.1.6.dist-info/METADATA,sha256=KPD6Y4p63u4q-Cq8cDJrRc-1pr6Fzh9irMbXvTiXgJQ,2355
+nbastatpy-0.1.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+nbastatpy-0.1.6.dist-info/RECORD,,

nbastatpy-0.1.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.6.1
+Root-Is-Purelib: true
+Tag: py3-none-any