Main_UserManual.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Main User Manual \n",
    "## By Bryan Delas Penas"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Phase 1 Overview: Gathering the Data\n",
    "<p> The main purpose of this phase was to generate data based on each Season, Team and, Player from the National Basketball Association to be used for the next two phases. Using basketball-reference.com, I created mutiple web scraper to scrape information.</p>\n",
    "\n",
    "<p> For <b>Season</b>, the stats being scraped is the name of teams for the given season, and the conference standings for the given season.</p>\n",
    "\n",
    "<p> For <b>Team</b>, the stats being scraped is a team's <b>advanced, misc, per_game, per_minute and totals</b>. <br> \n",
    "With the last three, <b>per_game, per_minute, and totals</b> also having the opponent's average against given team as well.</p>\n",
    "\n",
    "<p> For <b>Player</b> the stats being scraped is a player's <b>Advanced, Per_Game, Per_Minute, Per_Poss, and Totals</b><br> Each of these stats have a playoff varation if the player has ever played in the playoffs.With each player, they also have career averages for the stats above that also has a playoff varation if the player has ever made it in the playoffs</p>\n",
    "    \n",
    "## Python Moduels/ Libraries \n",
    "For <b>Phase One</b> of this project, these are the following modules needed to run each of the programs.\n",
    "```\n",
    "beautifulsoup4==4.9.3\n",
    "lxml==4.6.2\n",
    "numpy==1.19.2\n",
    "pandas==1.2.2\n",
    "requests==2.25.1\n",
    "unidecode==1.1.2  \n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## General Basketball Definitions \n",
    "\n",
    "### Efficiency Stats\n",
    "<strong>Per-Game:</strong> is the amount of any catergory the player gets and divide by the amount of games played. <br>\n",
    "<strong>Per-Minute:</strong> Is calculated by the total of any category(points, rebounds, etc.) and divided by total minutes played. Common notion is 36 or 40 minute stats.<br>\n",
    "<strong>Per-Possession:</strong> Instead of taking the number of minutes a player played to a 36 minute number, it compares the number of possessions a player was on the floor for the stat.<br>\n",
    "<strong>Totals:</strong> Is the total amount of any category<br>\n",
    "\n",
    "### Equations \n",
    "<strong>Assit Percentage</strong> or AST% =<br>\n",
    "```\n",
    "    100 * Assits / (((Minutes Played / (Team Minutes Played)) * Team Field Goals) - Field Goals)\n",
    "```\n",
    "<strong>Block Percentage</strong> or BLK% =<br>\n",
    "```\n",
    "    100 * (Block * (Team Minutes Played / 5)) / \n",
    "    (Minutes Played * (Opponent Field Goals Attempts - Opponent 3 Points Attempts))\n",
    "```\n",
    "<strong>Defensive Rebound Percentage</strong> or DRB% =<br>\n",
    "```\n",
    "    100 * (Defensive Rebound * (Team Minutes Played / 5)) / \n",
    "    (Minutes Played * (Team Defensive Rebound + Opponent Offensive Rebound))\n",
    "```\n",
    "<strong>Effective Field Goal Perventage</strong> or eFG% =<br>\n",
    "```\n",
    "    (Field Goals + 0.5 * 3 Points) / Field Goals Attempted\n",
    "```\n",
    "<strong>Games Behind</strong> or GB =<br>\n",
    "```\n",
    "    ((First Place Team Wins - Wins) + (Losses - First Place Team Losses)) / 2\n",
    "```\n",
    "<strong>Game Score</strong> or Game Score =<br>\n",
    "```\n",
    "    Points + 0.4 * Field Goals - 0.7 * Field Goals Attempts - 0.4*(Free Throw Attempt - Free Throw) \n",
    "    + 0.7 * Offensive Rebounds + 0.3 * Defensive Rebounds + Steals + 0.7 * Assits + 0.7 * Block - 0.4 * Personal Foul \n",
    "    - Turn Overs\n",
    "```\n",
    "<strong>Margin of Victory</strong> or MOV =<br>\n",
    "```\n",
    "    Points - Opponent Points\n",
    "```\n",
    "<strong>Offensive Rebound Percentage</strong> or ORB% =<br>\n",
    "```\n",
    "    100 * (Offensive Rebound * (Team Minutes Played / 5)) \n",
    "    / (Minutes Played * (Team Offensive Rebound + Opponent Defensive Rebound))\n",
    "```\n",
    "<strong>Pace Factor</strong> or Pace =<br>\n",
    "```\n",
    "    48 * ((Team Possession + Opponent Possession) / (2 * (Team Minutes Played / 5)))\n",
    "```\n",
    "<strong>Possession</strong> or Poss =<br>\n",
    "```\n",
    "    0.5 * ((Team Field Goals Attempts + 0.4 * Team Free Throw Attempts - 1.07 * \n",
    "    (Team Offensive Rebounds / (Team Offensive Rebounds + Opponnent Defensive Rebounds)) \n",
    "    * (Team Field Goals Attempts - Team Field Goals) + Team Turnover) + \n",
    "    (Opponent Field Goal Attempts + 0.4 * Opponent Free Throw Attempts - 1.07 * \n",
    "    (Opponent Offensive Rebound / (Opponent Offensive + Team Defensive)) * \n",
    "    (Opponent Field Goals Attempts - Opponnent Field Goals) + Opponent Turnover))\n",
    "```\n",
    "<strong>Steal Percentage</strong> or STL% =<br>\n",
    "```\n",
    "    100 * (Steal * (Team Minutes Played / 5)) / (Minutes Played * Opponent Possession)\n",
    "```\n",
    "<strong>Turnover Percentage</strong> or TOV% =<br>\n",
    "```\n",
    "    100 * Turnover / (Field Goals Attempts + 0.44 * Free Throw Attempts + Turnover)\n",
    "```\n",
    "<strong>Total Rebound Percentage</strong> or TRB% =<br>\n",
    "```\n",
    "    100 * (Total Rebound * (Team Minute Played / 5)) / (Minute Played * (Team Total Rebound + Opponent Total Rebound))\n",
    "```\n",
    "<strong>True Shooting Attempts:</strong> or TSA<br>\n",
    "```\n",
    "    (Field Goals Attempted + 0.44) / FTA\n",
    "```\n",
    "<strong>True Shooting:</strong> or TS% =<br>\n",
    "```\n",
    "    (Points) / (2 * True Shooting Attempts)\n",
    "```\n",
    "<strong>Usage Percentage</strong> or US% =<br>\n",
    "```\n",
    "    100 * ((Field Goals Attempted + 0.44 * Free Throw Attempted + Turn Overs) * (Team Minutes Played / 5)) \n",
    "    / (Minutes Played * (Team Field Goals + 0.44 * Team Free Throw Attempts + Team Turn Overs))\n",
    "```\n",
    "<strong>Win-Lost Percentage</strong> or W/L% =<br>\n",
    "```\n",
    "    Wins / (Wins + Loses)\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Notes when Running \n",
    "\n",
    "## Players ID\n",
    "<strong>NOTE:</strong> Players ID will change every time you run the program, as there could be a new players that could play in the nba, since this is dynamtic webscraper, if run, it will update when Basketball-Reference.com updates. Thus needing to change some Constants. "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Python Scrapers\n",
    "<p> In total there are three main files, that contain code for the scraper. Season, Team and Player Scrapers are the main scrapers. Also in the main files</p>\n",
    "\n",
    "## Python Scrapers Algorithm\n",
    "First, we find the url we are trying to scrape the information from, which we can just search through on basketball-reference website. After finding the information, by using the <strong>requests</strong> we can check if we get a response from the entered url to verify that it exists and is valid.<br>\n",
    "\n",
    "Since most of the information was inside of a javasript generated table instead of plain html, this lead to using a different embedded url, that was linked on the webpage.<br>\n",
    "\n",
    "By using <strong>beautifulsoup4</strong> and searching for `table`, we can gather the right information, and use <strong>pandas </strong> function `pd.read_html` to convert the html into a proper dataframe. <br>\n",
    "\n",
    "## Season_Stats_Scraper.py\n",
    "### `get_team_name(season)` \n",
    "<strong>Parameters:</strong><br>\n",
    "    - `season` - is a string that represents NBA season(only from 1980 to current year)<br>\n",
    "<strong>Returns:</strong><br>\n",
    "A Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team', 'Team ABV'] \n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int`, is the NBA season<br>\n",
    "    - `Team ID` - `Type: int`, is the unique int corresponding to a team<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "\n",
    "### `get_standings(season, data_format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    `season`      - NBA season(only from 1980 to current year)<br>\n",
    "    `data_format` - One of `'Standard'` where default value is `Standard`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "\n",
    "#### Standard \n",
    "For `Standard`, it will return two Pandas Dataframe, for Eastern Conference and Western Conference respectively but both will have the following columns\n",
    "```\n",
    "    ['Season', 'Team ID' , 'Team ABV', 'Team', 'W', 'L', 'W/L%', 'GB', 'PS/G', 'PA/G', 'SRS']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int` is the NBA season<br>\n",
    "    - `Team ID` - `Type: int` is the unique int corresponding to a team<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `W` - `Type: int` is the amount of wins a team has<br>\n",
    "    - `L` - `Type: int` is the amount of loses a team has<br>\n",
    "    - `W/L%` - `Type: float` is the percentage of wins divided by loses<br>\n",
    "    - `GB` - `Type: float` is the amount of games behind from first place<br>\n",
    "    - `PS/G` - `Type: float` is the Points per game<br>\n",
    "    - `PA/G` - `Type: float` is the Opponents Points per Game<br>\n",
    "    - `SRS` - `Type: float` is the team rating determined by average point differential and strength of schedule<br>\n",
    "\n",
    "## Team_Stats_Scraper.py \n",
    "### `get_roster(team, season)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `team`   - a string that represents a team in the NBA, takes in a team's abbreviation form<br>\n",
    "    - `season` - a string that represents a NBA season(only from 1980 to current year)<br>\n",
    "<strong>Returns:</strong><br>\n",
    "A Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', Number', 'Player', 'Pos', 'Height', 'Weight', 'Birth Date',\n",
    "    'Nationality' , 'Experience', 'College']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int`, is the NBA season<br>\n",
    "    - `Team ID` - `Type: int`, is the unique int corresponding to a team<br>\n",
    "    - `Player ID` - `Type: int` is the unique int respective to it's column, corresponding to a player<br> \n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Number` - `Type: int` is the player's jersey number<br>\n",
    "    - `Player` - `Type: string` is the name of the player<br>\n",
    "    - `Pos` - `Type: string` is the player's postion in the basketball court<br>\n",
    "    - `Height` - `Type: string` is the player's height, in feet and inches<br>\n",
    "    - `Weight` - `Type: int` is the player's weight in lbs<br>\n",
    "    - `Birth Date` - `Type: string` is the player's data of birth, in Month Day,Year<br>\n",
    "    - `Nationality` - `Type: string` is the player's country of origin, in abbreviation form<br>\n",
    "    - `Experience` - `Type: int` is the amount years the player's been in the leaue<br>\n",
    "    - `College` - `Type: string` if player went to college, this is the name of the college<br>\n",
    "\n",
    "### `get_team_stats_main(season, data_format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `season`      - a string that represent NBA season(only from 1980 to current year)<br>\n",
    "    - `data format` - a string that represent One of `'Per_Game' |'Per_Minute'| 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "\n",
    "#### Per Game\n",
    "For `Per_Game` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "#### Per Poss\n",
    "For `Per_Poss` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "#### Total\n",
    "For `Total` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "<strong>Note:</strong><br>\n",
    "The following stats, `Per_Game`, `Per_Poss`, and `Totals` all have the same columns<br>\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int`, is the NBA season<br>\n",
    "    - `Team ID` - `Type: int`, is the unique int corresponding to a team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `G` - `Type: int` is the amount of games the player played<br>\n",
    "    - `MP` - `Type: float` is the amount of minutes the player played<br>\n",
    "    - `FG` - `Type: float` is the amount Field Goals made<br>\n",
    "    - `FGA` - `Type: float` is the amount of Field Goals Attempted<br>\n",
    "    - `FG%` - `Type: float` is the percentage of Field Goals Made / Field Goals Attempted<br>\n",
    "    - `3P` - `Type: float` is the amount of 3 Point Shots Made<br>\n",
    "    - `3PA` - `Type: float` is the amount of 3 Point Shots Attempted<br>\n",
    "    - `3P%` - `Type: float` is the percentage of 3 Points Made / 3 Point Shot Attempted<br>\n",
    "    - `2P` - `Type: float` is the amount of 2 Point Made<br>\n",
    "    - `2PA` - `Type: float` is the amount of 2 Points Attempted<br>\n",
    "    - `2P%` - `Type: float` is the percentage of 2 Point Made / 2 Points Attemped<br>\n",
    "    - `FT` - `Type: float` is the amount of Free Throws Made<br>\n",
    "    - `FTA` - `Type: float` is the amount of Free Throws Attempted<br>\n",
    "    - `FT%` - `Type: float` is the percentage of Free Throws Made / Free Throws Attempted<br>\n",
    "    - `ORB` - `Type: float` is the amount of Offensive Rebound<br>\n",
    "    - `DRB` - `Type: float` is the amount of Defensive Rebound<br>\n",
    "    - `TRB` - `Type: float` is the amount of Rebound<br>\n",
    "    - `AST` - `Type: float` is the amount of Assist<br>\n",
    "    - `STL` - `Type: float` is the amount of Steals<br>\n",
    "    - `BLK` - `Type: float` is the amount of Blocks<br>\n",
    "    - `TOV` - `Type: float` is the amount of Turn Overs<br>\n",
    "    - `PF` - `Type: float` is the amount of Personal Fouls<br>\n",
    "    - `PTS` - `Type: float` is the amount of Points Scored<br>\n",
    "\n",
    "### `get_opp_stats(season, data_format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `season`      - is a string that represents NBA season(only from 1980 to current year)<br>\n",
    "    - `data format` - is a string that represents One of `'Per_Game' |'Per_Minute'| 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "\n",
    "#### Per Game\n",
    "For `Per_Game` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "#### Per Poss\n",
    "For `Per_Poss` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "#### Total\n",
    "For `Total` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'G', 'MP', 'FG', 'FGA', 'FG%', '3P', '3PA', '3P%',\n",
    "    '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', 'PTS']\n",
    "```\n",
    "<strong>Note:</strong><br>\n",
    "The following stats, `Per_Game`, `Per_Poss`, and `Totals` all have the same columns<br>\n",
    "<strong>Also, These are all opponent averages agaist a certain team</strong><br>\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int`, is the NBA season<br>\n",
    "    - `Team ID` - `Type: int`, is the unique int corresponding to a team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `G` - `Type: int` is the amount of games the player played<br>\n",
    "    - `MP` - `Type: float` is the amount of minutes the player played<br>\n",
    "    - `FG` - `Type: float` is the amount Field Goals made<br>\n",
    "    - `FGA` - `Type: float` is the amount of Field Goals Attempted<br>\n",
    "    - `FG%` - `Type: float` is the percentage of Field Goals Made / Field Goals Attempted<br>\n",
    "    - `3P` - `Type: float` is the amount of 3 Point Shots Made<br>\n",
    "    - `3PA` - `Type: float` is the amount of 3 Point Shots Attempted<br>\n",
    "    - `3P%` - `Type: float` is the percentage of 3 Points Made / 3 Point Shot Attempted<br>\n",
    "    - `2P` - `Type: float` is the amount of 2 Point Made<br>\n",
    "    - `2PA` - `Type: float` is the amount of 2 Points Attempted<br>\n",
    "    - `2P%` - `Type: float` is the percentage of 2 Point Made / 2 Points Attemped<br>\n",
    "    - `FT` - `Type: float` is the amount of Free Throws Made<br>\n",
    "    - `FTA` - `Type: float` is the amount of Free Throws Attempted<br>\n",
    "    - `FT%` - `Type: float` is the percentage of Free Throws Made / Free Throws Attempted<br>\n",
    "    - `ORB` - `Type: float` is the amount of Offensive Rebound<br>\n",
    "    - `DRB` - `Type: float` is the amount of Defensive Rebound<br>\n",
    "    - `TRB` - `Type: float` is the amount of Rebound<br>\n",
    "    - `AST` - `Type: float` is the amount of Assist<br>\n",
    "    - `STL` - `Type: float` is the amount of Steals<br>\n",
    "    - `BLK` - `Type: float` is the amount of Blocks<br>\n",
    "    - `TOV` - `Type: float` is the amount of Turn Overs<br>\n",
    "    - `PF` - `Type: float` is the amount of Personal Fouls<br>\n",
    "    - `PTS` - `Type: float` is the amount of Points Scored<br>\n",
    "\n",
    "### `get_team_misc(season)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `season` - NBA season(only from 1980 to current year)<br>\n",
    "<strong>Returns:</strong><br>\n",
    "A Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'Age', 'W', 'L', 'PW', 'PL', 'MOV', 'SOS', 'SRS', 'ORtg', 'DRtg', 'NRtg', \n",
    "    'Pace', 'FTr', '3PAr', 'TS%', 'ORB%', 'DRB%', 'Arena', 'Attend.', 'Attend./G']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int`, is the NBA season<br>\n",
    "    - `Team ID` - `Type: int`, is the unique int corresponding to a team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Age` - `Type: float` is the average age of the player<br>\n",
    "    - `W` - `Type: float` is the amount of wins for a team<br>\n",
    "    - `L` - `Type: float` is the amount of loses for a team<br>\n",
    "    - `PW` - `Type: int` is the Pythagorean wins or expected wins based on points scored and allowed<br>\n",
    "    - `PL` - `Type: int` is the Pythagorean loses or expected wins based on points scored and allowed<br>\n",
    "    - `MOV` - `Type: float` is the margin of victory<br>\n",
    "    - `SOS` - `Type: float` is the Strength of Schedule, a rating of how hard a schedule is<br>\n",
    "    - `SRS` - `Type: float` is the Simple Rating System, a team rating that takes into account average point differential and strength of schedule<br>\n",
    "    - `ORtg` - `Type: float` an estiamte of points scored by a team per 100 possessions<br>\n",
    "    - `DRtg` - `Type: float` an estiamte of points allowed per 100 possessions<br>\n",
    "    - `NRtg` - `Type: float` an estimate of points differential per 100 possessions<br>\n",
    "    - `Pace` - `Type: float` an estimate of possessions per 48 minutes<br>\n",
    "    - `FTr` - `Type: float` is the number of FT Attempts per FG Attempt<br>\n",
    "    - `3PAr` - `Type: float` Percentage of FG Attempts from 3-Point Range<br>\n",
    "    - `TS%` - `Type: float` is the measurement of shooting efficiency<br>\n",
    "    - `ORB%` - `Type: float` is an estimated percentage of available offensive rebounds a player takes when in game<br>\n",
    "    - `DRB%` - `Type: float` is an estimated percentage of available defensive rebounds a player takes when in game<br>\n",
    "    - `Arena` - `Type: string` is the Area name for the team<br>\n",
    "    - `Attend.` `Type: int` is the amount of people who attend the Area the whole season<br>\n",
    "    - `Attend./G` `Type: int` is the average amount of people who attend a game<br>\n",
    "\n",
    "### `get_team_advanced(team, season)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `team`   - A team in the NBA for that season, abbreviation<br>\n",
    "    - `season` - NBA season(only from 1980 to current year)<br>\n",
    "<strong>Returns:</strong><br>\n",
    "A pandas dataframe containing the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Team ABV', 'Team', 'W', 'L', 'W/L%', 'Finish', 'SRS', 'Pace', 'Rel Pace', 'ORtg', 'Rel ORtg', \n",
    "    'DRtg', 'Rel DRtg', 'Playoffs', 'Coaches', 'Top WS']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: int` is the NBA season<br>\n",
    "    - `Team ID` - `Type: int` is the unique int corresponding to a team<br>\n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `W` - `Type: int` is the amount of wins for a team<br>\n",
    "    - `L` - `Type: int` is the amount of loses for a team<br>\n",
    "    - `W/L%` - `Type: float` is the percentage of wins divided by loses<br>\n",
    "    - `Finish` - `Type: string` is the Regular Season finish within the team's respective Division <br>\n",
    "    - `SRS` - `Type: float` is the team rating determined by average point differential and strength of schedule<br>\n",
    "    - `Pace` - `Type: float` an estimate of possessions per 48 minutes<br>\n",
    "    - `Rel Pace` - `Type: float` an estimate of a Team's possessions per 48 minutes relative to the league<br>\n",
    "    - `ORtg` - `Type: float` an estimate of <br>\n",
    "    - `Rel Ortg` - `Type: float` is the Team's offensive rating relative to the league<br>\n",
    "    - `DRtg` - `Type: float` an estiamte of points allowed per 100 possessions<br>\n",
    "    - `Rel DRtg` - `Type: float` is the Team's defensive rating relative to the league<br>\n",
    "    - `Playoffs` - `Type: string` is where the team was eliminated if they made the playoffs<br>\n",
    "    - `Coaches` - `Type: string` is the coache of the team<br>\n",
    "\n",
    "### `remove_char(string, postion)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `string`   - a string that needs to have a char removes<br>\n",
    "    - `postion`  - a int that represents the index of the string<br>\n",
    "<strong>Returns:</strong><br>\n",
    "A sub-string of the orginal `string` that has a char removed at whatever `postion` is<br>\n",
    "\n",
    "## Player_Stats_Scraper.py\n",
    "### `check_abv(string)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `string`   - a string that represent a team's abbreviation<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Returns a `new_string`, which is a string value from `TEAM_TO_ABBRIVATION[string]`\n",
    "\n",
    "### `check_team_id(name)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `string`   - a string that represent a team's name<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Returns a `new_num`, which is a int value from `TEAM_ID[name]`\n",
    "\n",
    "### `create_player_suffix(name)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`   - is a string that represents the player's name, first and last<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Returns a string suffix of the player's first name and last<br> \n",
    "<strong>Example:</strong> Nikola Jokic = jokicni<br>\n",
    "\n",
    "### `get_player_suffix(name, birth_date)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`      - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date` - is a string that represents the player's date of birth<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Returns a string suffix for the url of the player's page by calling `create_player_suffix` and adding 01. If not valid, iterate until 05<br>\n",
    "<strong>Example:</strong> Nikola Jokic = jokicni01<br>\n",
    "\n",
    "### `get_player_stats(name, birth_date,format, playoffs)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`        - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date`   - is a string that represents the player's date of birth<br>\n",
    "    - `playoffs`    - is a boolean that checks if the regular season or playoffs<br>\n",
    "    - `data format` - is a string that could be `'Advanced' | 'Per_Game' |'Per_Minute'| Per_Poss | 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "\n",
    "#### Advanced \n",
    "For `Advanced` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'MP', 'PER', 'TS%', '3PAr', \n",
    "    'FTr', 'ORB%', 'DRB%', 'TRB%', 'AST%', 'STL%', 'BLK%', 'TOV%', 'USG%', 'OWS', 'DWS', 'WS', 'WS/48', 'OBPM', \n",
    "    'DBPM', 'BPM', 'VORP', 'Stat_Form']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: string` is the NBA season<br>\n",
    "    - `Team ID` - `Type: int` is the unique int respective to it's column, corresponding to a team<br>\n",
    "    - `Player ID` - `Type: int` is the unique int respective to it's column, corresponding to a player<br> \n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Player` - `Type: string` is the name of the player<br>\n",
    "    - `Age` - `Type: int` is the age of the player<br>\n",
    "    - `G` - `Type: int` is the amount of games played<br>\n",
    "    - `MP` - `Type: int` is the amount of minutes played<br>\n",
    "    - `PER` - `Type: float` is the measurment of a player's per-minute production<br>\n",
    "    - `TS%` - `Type: float` is the measurement of shooting efficiency<br>\n",
    "    - `3PAr` - `Type: float` is the percentage of FG Attempts from the 3 Point line<br>\n",
    "    - `FTr` - `Type: float` is the number of FT Attempts per Field Goal Attempts<br>\n",
    "    - `ORB%` - `Type: float` is an estimated percentage of available offensive rebounds a player takes when in game<br>\n",
    "    - `DRB%` - `Type: float` is an estimated percentage of available defensive rebounds a player takes when in game<br>\n",
    "    - `TRB%` - `Type: float` is an estimated percentage of available  rebounds a player takes when in game<br>\n",
    "    - `AST%` - `Type: float` is an estimated percentage of teammate Field Goals a palyer assited while in game<br>\n",
    "    - `STL%` - `Type: float` is an estimate percentage of opponent possessions that end with a steal by player while in game<br>\n",
    "    - `BLK%` - `Type: float` is an estimate of the percentage of opponent Field Goal Attempts blocked by player while in game<br>\n",
    "    - `TOV%` - `Type: float` is an estimate of turnovers commited per 100 plays<br>\n",
    "    - `USG%` - `Type: float` is an estimate of percentage of team plays used by a player while in game<br>\n",
    "    - `OWS` - `Type: float` is an estimate of the number of wins contributed by a player due to his offense<br>\n",
    "    - `DWS` - `Type: float` is an estimate of the number of wins contributed by a player due to his defense<br>\n",
    "    - `WS` - `Type: float` is an estimate of the number of wins contributed by a player<br>\n",
    "    - `WS/48` - `Type: float` is an estimate of the number of wins contributed by a player per 48 minute<br>\n",
    "    - `OBPM` - `Type: float` is a box score estimate of the offensive points per 100 possessions a player contributed<br>\n",
    "    - `DBPM` - `Type: float` is a box score estimate of the defensive points per 100 possessions a player contributed<br>\n",
    "    - `BPM` - `Type: float` is a box score estimate of the points per 100 possessions a player contributed<br>\n",
    "    - `VORP` - `Type: float` is a box score estimate of the points per 100 Team possessions that a play contributed<br>\n",
    "\n",
    "#### Per_Game\n",
    "For `Per_Game` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "    '3PA', '3P%','2P', '2PA', '2P%', 'eFG%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', \n",
    "    'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "#### Per_Minute\n",
    "For `Per_Minute` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P',\n",
    "    '3PA', '3P%','2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', \n",
    "    'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "#### Per_Poss\n",
    "For `Per_Poss` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "     ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "     '3PA', '3P%','2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', \n",
    "     'PTS', 'Ortg', 'Drtg', 'Stat_Form']\n",
    "```\n",
    "#### Totals\n",
    "For `Totals` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', \n",
    "    '3P', '3PA', '3P%','2P', '2PA', '2P%', 'eFG%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', \n",
    "    'BLK', 'TOV', 'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "<strong>Note:</strong><br>\n",
    "For the following stats `Per_Game`, `Per_Minute`, `Per_Poss` and `Totals` have almost identical columns except `Per_Game` & `Totals` have<br>\n",
    "```\n",
    "    ['eFG%]\n",
    "```\n",
    "While `Per_Minute` && `Per_Poss` do not have it, Also `Per_Poss` contains<br>\n",
    "```\n",
    "    ['Ortg', 'Drtg']\n",
    "```\n",
    "Lastly `Totals` contains<br>\n",
    "```\n",
    "    ['Trp_Dbl']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` is the NBA season<br>\n",
    "    - `Team ID` is the unique int respective to it's column, corresponding to a team<br>\n",
    "    - `Player ID` is the unique int respective to it's column, corresponding to a player<br> \n",
    "    - `Team ABV` is the team abbreviation<br>\n",
    "    - `Team` is the name of the Team<br>\n",
    "    - `Player` is the name of the player <br>\n",
    "    - `Age` is the age of the player<br>\n",
    "    - `G` - `Type: int` is the amount of games the player played<br>\n",
    "    - `GS` - `Type: int` is the amount of games the player started<br>\n",
    "    - `MP` - `Type: float` is the amount of minutes the player played<br>\n",
    "    - `FG` - `Type: float` is the amount Field Goals made<br>\n",
    "    - `FGA` - `Type: float` is the amount of Field Goals Attempted<br>\n",
    "    - `FG%` - `Type: float` is the percentage of Field Goals Made / Field Goals Attempted<br>\n",
    "    - `3P` - `Type: float` is the amount of 3 Point Shots Made<br>\n",
    "    - `3PA` - `Type: float` is the amount of 3 Point Shots Attempted<br>\n",
    "    - `3P%` - `Type: float` is the percentage of 3 Points Made / 3 Point Shot Attempted<br>\n",
    "    - `2P` - `Type: float` is the amount of 2 Point Made<br>\n",
    "    - `2PA` - `Type: float` is the amount of 2 Points Attempted<br>\n",
    "    - `2P%` - `Type: float` is the percentage of 2 Point Made / 2 Points Attemped<br>\n",
    "    - `FT` - `Type: float` is the amount of Free Throws Made<br>\n",
    "    - `FTA` - `Type: float` is the amount of Free Throws Attempted<br>\n",
    "    - `FT%` - `Type: float` is the percentage of Free Throws Made / Free Throws Attempted<br>\n",
    "    - `ORB` - `Type: float` is the amount of Offensive Rebound<br>\n",
    "    - `DRB` - `Type: float` is the amount of Defensive Rebound<br>\n",
    "    - `TRB` - `Type: float` is the amount of Rebound<br>\n",
    "    - `AST` - `Type: float` is the amount of Assist<br>\n",
    "    - `STL` - `Type: float` is the amount of Steals<br>\n",
    "    - `BLK` - `Type: float` is the amount of Blocks<br>\n",
    "    - `TOV` - `Type: float` is the amount of Turn Overs<br>\n",
    "    - `PF` - `Type: float` is the amount of Personal Fouls<br>\n",
    "    - `PTS` - `Type: float` is the amount of Points Scored<br>\n",
    "\n",
    "### `lookup(name, birth_date)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`      - Takes in a string that represents the player's name, first and last<br>\n",
    "    - `birth_date` - Takes in a string that represents the player's date of birth<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Returns a tuple of `(name, birth_date)` if it exists in `player_names.csv`<br>\n",
    "\n",
    "### `get_career_stats(name, birth_date, format, playoffs)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`        - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date`   - is a string that represents the player's date of birth<br>\n",
    "    - `playoffs`    - is a boolean that checks if the regular season or playoffs<br>\n",
    "    - `data format` - is a string that could be `'Advanced' | 'Per_Game' |'Per_Minute'| Per_Poss | 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "\n",
    "<strong>Note:</strong><br>\n",
    "Career Averages are the average of each column, the only one that is different is `Totals`, where it is the sum of every column<br>\n",
    "For `Advanced`, All winshares are sumed up instead of averaged<br> \n",
    "\n",
    "#### Advanced \n",
    "For `Advanced` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'MP', 'PER', 'TS%', '3PAr', \n",
    "    'FTr', 'ORB%','DRB%', 'TRB%', 'AST%', 'STL%', 'BLK%', 'TOV%', 'USG%', 'OWS', 'DWS', 'WS', 'WS/48', \n",
    "    'OBPM', 'DBPM', 'BPM', 'VORP', 'Stat_Form']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` - `Type: string` is the NBA season<br>\n",
    "    - `Team ID` - `Type: int` is the unique int respective to it's column, corresponding to a team<br>\n",
    "    - `Player ID` - `Type: int` is the unique int respective to it's column, corresponding to a player<br> \n",
    "    - `Team ABV` - `Type: string` is the team abbreviation<br>\n",
    "    - `Team` - `Type: string` is the name of the Team<br>\n",
    "    - `Player` - `Type: string` is the name of the player<br>\n",
    "    - `Age` - `Type: int` is the age of the player<br>\n",
    "    - `G` - `Type: int` is the amount of games played<br>\n",
    "    - `MP` - `Type: int` is the amount of minutes played<br>\n",
    "    - `PER` - `Type: float` is the measurment of a player's per-minute production<br>\n",
    "    - `TS%` - `Type: float` is the measurement of shooting efficiency<br>\n",
    "    - `3PAr` - `Type: float` is the percentage of FG Attempts from the 3 Point line<br>\n",
    "    - `FTr` - `Type: float` is the number of FT Attempts per Field Goal Attempts<br>\n",
    "    - `ORB%` - `Type: float` is an estimated percentage of available offensive rebounds a player takes when in game<br>\n",
    "    - `DRB%` - `Type: float` is an estimated percentage of available defensive rebounds a player takes when in game<br>\n",
    "    - `TRB%` - `Type: float` is an estimated percentage of available  rebounds a player takes when in game<br>\n",
    "    - `AST%` - `Type: float` is an estimated percentage of teammate Field Goals a palyer assited while in game<br>\n",
    "    - `STL%` - `Type: float` is an estimate percentage of opponent possessions that end with a steal by player while in game<br>\n",
    "    - `BLK%` - `Type: float` is an estimate of the percentage of opponent Field Goal Attempts blocked by player while in game<br>\n",
    "    - `TOV%` - `Type: float` is an estimate of turnovers commited per 100 plays<br>\n",
    "    - `USG%` - `Type: float` is an estimate of percentage of team plays used by a player while in game<br>\n",
    "    - `OWS` - `Type: float` is an estimate of the number of wins contributed by a player due to his offense<br>\n",
    "    - `DWS` - `Type: float` is an estimate of the number of wins contributed by a player due to his defense<br>\n",
    "    - `WS` - `Type: float` is an estimate of the number of wins contributed by a player<br>\n",
    "    - `WS/48` - `Type: float` is an estimate of the number of wins contributed by a player per 48 minute<br>\n",
    "    - `OBPM` - `Type: float` is a box score estimate of the offensive points per 100 possessions a player contributed<br>\n",
    "    - `DBPM` - `Type: float` is a box score estimate of the defensive points per 100 possessions a player contributed<br>\n",
    "    - `BPM` - `Type: float` is a box score estimate of the points per 100 possessions a player contributed<br>\n",
    "    - `VORP` - `Type: float` is a box score estimate of the points per 100 Team possessions that a play contributed<br>\n",
    "\n",
    "#### Per_Game\n",
    "For `Per_Game` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "    '3PA','3P%', '2P', '2PA', '2P%', 'eFG%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', \n",
    "    'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "#### Per_Minute\n",
    "For `Per_Minute` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "    '3PA','3P%', '2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', \n",
    "    'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "#### Per_Poss\n",
    "For `Per_Poss` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "     ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "     '3PA','3P%','2P', '2PA', '2P%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', 'PF', \n",
    "     'PTS', 'Ortg', 'Drtg', 'Stat_Form']\n",
    "```\n",
    "#### Totals\n",
    "For `Totals` a Pandas Dataframe with the following columns<br>\n",
    "```\n",
    "    ['Season', 'Team ID', 'Player ID', 'Team ABV', 'Team', 'Player', 'Age', 'G', 'GS', 'MP', 'FG', 'FGA', 'FG%', '3P', \n",
    "    '3PA', '3P%', '2P', '2PA', '2P%', 'eFG%', 'FT', 'FTA', 'FT%', 'ORB', 'DRB', 'TRB', 'AST', 'STL', 'BLK', 'TOV', \n",
    "    'PF', 'PTS', 'Stat_Form']\n",
    "```\n",
    "<strong>Note:</strong><br>\n",
    "For the following stats `Per_Game`, `Per_Minute`, `Per_Poss` and `Totals` have almost identical columns except `Per_Game` & `Totals` have<br>\n",
    "```\n",
    "    ['eFG%]\n",
    "```\n",
    "While `Per_Minute` && `Per_Poss` do not have it, Also `Per_Poss` contains<br>\n",
    "```\n",
    "    ['Ortg', 'Drtg']\n",
    "```\n",
    "Lastly `Totals` contains<br>\n",
    "```\n",
    "    ['Trp_Dbl']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `Season` is the NBA season<br>\n",
    "    - `Team ID` is the unique int respective to it's column, corresponding to a team<br>\n",
    "    - `Player ID` is the unique int respective to it's column, corresponding to a player<br> \n",
    "    - `Team ABV` is the team abbreviation<br>\n",
    "    - `Team` is the name of the Team<br>\n",
    "    - `Player` is the name of the player <br>\n",
    "    - `Age` is the age of the player<br>\n",
    "    - `G` - `Type: int` is the amount of games the player played<br>\n",
    "    - `GS` - `Type: int` is the amount of games the player started<br>\n",
    "    - `MP` - `Type: float` is the amount of minutes the player played<br>\n",
    "    - `FG` - `Type: float` is the amount Field Goals made<br>\n",
    "    - `FGA` - `Type: float` is the amount of Field Goals Attempted<br>\n",
    "    - `FG%` - `Type: float` is the percentage of Field Goals Made / Field Goals Attempted<br>\n",
    "    - `3P` - `Type: float` is the amount of 3 Point Shots Made<br>\n",
    "    - `3PA` - `Type: float` is the amount of 3 Point Shots Attempted<br>\n",
    "    - `3P%` - `Type: float` is the percentage of 3 Points Made / 3 Point Shot Attempted<br>\n",
    "    - `2P` - `Type: float` is the amount of 2 Point Made<br>\n",
    "    - `2PA` - `Type: float` is the amount of 2 Points Attempted<br>\n",
    "    - `2P%` - `Type: float` is the percentage of 2 Point Made / 2 Points Attemped<br>\n",
    "    - `FT` - `Type: float` is the amount of Free Throws Made<br>\n",
    "    - `FTA` - `Type: float` is the amount of Free Throws Attempted<br>\n",
    "    - `FT%` - `Type: float` is the percentage of Free Throws Made / Free Throws Attempted<br>\n",
    "    - `ORB` - `Type: float` is the amount of Offensive Rebound<br>\n",
    "    - `DRB` - `Type: float` is the amount of Defensive Rebound<br>\n",
    "    - `TRB` - `Type: float` is the amount of Rebound<br>\n",
    "    - `AST` - `Type: float` is the amount of Assist<br>\n",
    "    - `STL` - `Type: float` is the amount of Steals<br>\n",
    "    - `BLK` - `Type: float` is the amount of Blocks<br>\n",
    "    - `TOV` - `Type: float` is the amount of Turn Overs<br>\n",
    "    - `PF` - `Type: float` is the amount of Personal Fouls<br>\n",
    "    - `PTS` - `Type: float` is the amount of Points Scored<br>\n",
    "\n",
    "## Team_Constants.py \n",
    "### `TEAM_TO_ABBRIVATION`\n",
    "Is a dictionary that takes in a team name as a key and converts it into an abbreviation<br>\n",
    "<strong>Example</strong> `ATLANTA HAWKS` is converted into `ATL`<br>\n",
    "\n",
    "### `ABV_TO_TEAM` \n",
    "Is a dictionary that takes in an abbreviation as a key and converts it into a team name \n",
    "<strong>Example:</strong> `ATL` is converted into `ATLANTA HAWKS`<br>\n",
    "\n",
    "### `TEAM_ID`\n",
    "Is a dictionary that takes in an abbreviation as a key and converts it into a int corresponding to a unique nba franchise<br>\n",
    "<strong>Example:</strong> `CHO` is converted into `4`<br>\n",
    "<strong>Example:</strong> `CHA` is converted into `4`<br>\n",
    "They contain the same number as they are the same franchise but changed names over the years<br>\n",
    "\n",
    "### `TEAM_DICT` \n",
    "Is a dictionary that takes in old franchise abbreviation and converts it to its mondern day counter part<br>\n",
    "<strong>Example:</strong> `SEA` is converted into `OKC`<br>\n",
    "\n",
    "### `RIGHT_NAME_DICT` \n",
    "Is a dictionary that takes in a string tuple `(player_name, birth_date)` that converts wrong names into the proper name<br>\n",
    "<strong>Example:</strong> `(Tim Hardaway, March 16, 1992)` is converted into `Tim Hardaway Jr.`<br>\n",
    "\n",
    "### `REVERSE_RIGHT_DICT`\n",
    "Is a dictionary that takes in a proper name, or `name` that converts into the wrong version<br>\n",
    "<strong>Example:</strong>`Marvin Bagley III` is convert into `Marvin Bagley`<br>\n",
    "\n",
    "### `RIGHT_PLAYER_SUFIX`\n",
    "Is a dictionary that takes in a string tuple `(player_name, birth_date)` that converts wrong name's suffix into proper names that can become a proper suffix<br>\n",
    "<strong>Example:</strong> `(J.J. Barea, June 26, 1984)` is converted into `Jose Barea`\n",
    "\n",
    "### `SPECIAL_NAME_DICT`\n",
    "Is a dictionary that takes in a string tuple `(player_name, birth_date)` that converts into a new name, this is used for duplicate names<br>\n",
    "<strong>Example:</strong> `(Nene Hilario, September 13, 1982)` is converted into `Nene`\n",
    "\n",
    "### `DATABASE_DICT`\n",
    "Is a dictionary that takes in a string `name`, that converts into a 2-d list that can be inserted into the databases<br>\n",
    "<strong>Example:</strong> `(Dorell Wright)` is converted into `[[2016, 16, 3244, 'MIA', 'Miami Heat', 'December 2, 1985', 'Dorell Wright']]`\n",
    "\n",
    "### `get_player_id()`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `None`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "None, it is a helper function for `PLAYER_ID`, as it inserts all key and values into the dictionary<br>\n",
    "\n",
    "### `PLAYER_ID`\n",
    "Is a dictionary that takes in a NBA players `name` as a key and converts into a unique corresponding to the name\n",
    "<strong>Example:</strong> `Tim Hardaway` is converted to `1183`\n",
    "\n",
    "## Create_Player_Names.py\n",
    "### `get_player_name(letter)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `string`   - Takes in a char, iterated to get all players name in the English Alphabet<br>\n",
    "<strong>Returns:</strong><br>\n",
    "Creates a Pandas Dataframe containing the following columns\n",
    "```\n",
    "    ['Player', 'Birth Date']\n",
    "```\n",
    "<strong>Where:</strong><br>\n",
    "    - `player` is a string that represents the name of the player<br>\n",
    "    - `birth date` is a string that represents the date of birth of the player<br>\n",
    "    \n",
    "### `player_names_csv()`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `None`<br>\n",
    "<strong>Returns:</strong><br>\n",
    "None, creates a csv containing all Players active from 1980 - current year\n",
    "\n",
    "## Utlis.py\n",
    "### `strip_accents(text)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `text` - Takes in a string, for the player's name<br>\n",
    "\n",
    "<strong>Returns:</strong><br>\n",
    "A `new_string` if the text contains special char or accent<br>\n",
    "This is used for the `get_roster`, as they have proper UTF-8 notation <br>\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Testing The Scrapers\n",
    "Each of the scrapers is using unit tests through the module <strong>unittest</strong>.<br> \n",
    "\n",
    "<strong>Note:</strong> Running the scraper changes the test data, so the test may have to be changed \n",
    "\n",
    "\n",
    "## Test_Season_Scraper.py\n",
    "### `test_get_team_name(season)` \n",
    "<strong>Parameters:</strong><br>\n",
    "    - `season` - is a string that represents NBA season(only from 1980 to current year)<br>\n",
    "<strong>Test:</strong><br>\n",
    "Tests the function get_team_name, with the parameter being `season` = `2020`. Compares with the output from <strong>`csv_team_names`</strong>. \n",
    "\n",
    "### `test_get_standings(season, data_format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    `season`      - NBA season(only from 1980 to current year)<br>\n",
    "    `data_format` - One of `'Standard'` where default value is `Standard`<br>\n",
    "<strong>Test:</strong><br>\n",
    "Tests the function <strong>`get_standings`</strong>, with the parameter being `season` = `2020` and `data_format` = standard. Compares with the output from <strong>`csv_standings`</strong>. \n",
    "\n",
    "## Test_Team_Scraper.py\n",
    "### `test_get_roster(year)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `year` - NBA season(only from 1980 to current year)<br>\n",
    "<strong>Test:</strong><br>\n",
    "Test the function <strong>`get_roster`</strong>, with the parameter being `year` = `2020`. Compares with the output from <strong>`csv_team_roster`</strong>. \n",
    "\n",
    "### `test_get_team_stats(year, format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `year`       - a string that represents NBA season(only from 1980 to current year)<br>\n",
    "    - `format`     - a string represents what format, it could be one of the following `'Per_Game' | 'Per_Poss' | 'Totals'`<br>\n",
    "<strong>Test:</strong><br>\n",
    "Test the function <strong>`get_team_stats`</strong>, with the parameter being `year` = `2020`. Compares with the output from <strong>`csv_team_stats_main`</strong>. \n",
    "\n",
    "### `test_get_opp_stats(year, format)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `year`       - a string that represents NBA season(only from 1980 to current year)<br>\n",
    "    - `format`     - a string represents what format, it could be one of the following `'Per_Game' | 'Per_Poss' | 'Totals'`<br>\n",
    "<strong>Test:</strong><br>\n",
    "Test the function <strong>`get_opp_stats`</strong>, with the parameter being and the format being the three above and `year` = `2020`. Compares with the output from <strong>`csv_team_roster`</strong>. \n",
    "\n",
    "### `test_get_team_misc(year)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `year`       - a string that represents NBA season(only from 1980 to current year)<br>\n",
    "<strong>Test:</strong><br>\n",
    "Test the function <strong>`get_team_misc`</strong>, with the parameter being `year` = `2020`. Compares with the output from <strong>`csv_team_stats_main`</strong>.\n",
    "\n",
    "### `test_get_team_advanced(year)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `team`   - A team in the NBA for that season, abbreviation<br>\n",
    "    - `year`       - a string that represents NBA season(only from 1980 to current year)<br>\n",
    "<strong>Test:</strong><br>\n",
    "Test the function <strong>`get_team_advanced`</strong>, with the parameter being `team` = `DAL` and `year` = `2020`. Compares with the output from <strong>`csv_team_roster`</strong>.    \n",
    "\n",
    "\n",
    "## Test_Player_Scraper.py\n",
    "### `test_get_player_suffix`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`        - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date`   - is a string that represents the player's date of birth<br>\n",
    "<strong>Tests:</strong><br>\n",
    "Tests if the function <strong>`get_player_suffix`</strong> returns a proper url for basketball-reference. \n",
    "\n",
    "### `get_player_stats(name, birth_date,format, playoffs)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`        - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date`   - is a string that represents the player's date of birth<br>\n",
    "    - `playoffs`    - is a boolean that checks if the regular season or playoffs<br>\n",
    "    - `data format` - is a string that could be `'Advanced' | 'Per_Game' |'Per_Minute'| Per_Poss | 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Test:</strong><br>\n",
    "Tests the function <strong>`get_player_stats`</strong> with parameters being `name` = `Kareem Abdul-Jabbar_Regular`, `birth_date` = `April 16, 1947`, `playoffs` equaling both true and false and `data format` being the 5 above. Compares results from <strong>`csv_player_stats`</strong> \n",
    "\n",
    "### `test_get_career_stats(name, birth_date, format, playoffs)`\n",
    "<strong>Parameters:</strong><br>\n",
    "    - `name`        - is a string that represents the player's name, first and last<br>\n",
    "    - `birth_date`   - is a string that represents the player's date of birth<br>\n",
    "    - `playoffs`    - is a boolean that checks if the regular season or playoffs<br>\n",
    "    - `data format` - is a string that could be `'Advanced' | 'Per_Game' |'Per_Minute'| Per_Poss | 'Totals'` where default value is `Per_Game`<br>\n",
    "<strong>Test:</strong><br>\n",
    "Tests the function <strong>`get_career_stats`</strong> with parameters being `name` = `Kareem Abdul-Jabbar_Regular`, `birth_date` = `April 16, 1947`, `playoffs` equaling both true and false and `data format` being the 5 above. Compares results from <strong>`csv_career_stats`</strong> "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Output\n",
    "File system of the Output Directory\n",
    "```\n",
    "Output |---> Player -------------------------------> Player_Name ---> Career_Playoff_Stats -> |-> Advanced\n",
    "       |                                             |                                        | \n",
    "       |                                             |--------------> Career_Regular_Stats -> |-> Per_Game\n",
    "       |----> Player_Name                            |                                        |\n",
    "       |                                             |--------------> Playoffs_Stats -------> |-> Per_Minute\n",
    "       |                                             |                                        |\n",
    "       |----> Season --> Standings ----> East        |--------------> Regular_Stats ------>   |-> Per_Poss\n",
    "       |      |          |                                                                    |\n",
    "       |      |          |-------------> West                                                 |-> Totals\n",
    "       |      |\n",
    "       |      |--------> Team_Names \n",
    "       |\n",
    "       |----> Team ----> Roster \n",
    "              |\n",
    "              |--------> Team_Stats ---> Opponent_Averages ---> Opp_Per_Game\n",
    "                         |               |\n",
    "                         |               |--------------------> Opp_Per_Poss\n",
    "                         |               |\n",
    "                         |               |--------------------> Opp_Total\n",
    "                         |\n",
    "                         |\n",
    "                         |-------------> Team_Advanced \n",
    "                         |               \n",
    "                         |              \n",
    "                         |-------------> Team_Stats -----------> Per_Game\n",
    "                                         |\n",
    "                                         |---------------------> Per_Poss\n",
    "                                         |\n",
    "                                         |---------------------> Team_Misc\n",
    "                                         |\n",
    "                                         |---------------------> Total\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}