Python API wrapper for stats.nba.com with a focus on NBA and WNBA applications
Project description
py_ball
Python API wrapper for stats.nba.com with a focus on NBA and WNBA applications
Introduction
The motivation for this stems from nba_py by seemethere and nbastatsR by abresler. The work towards a Python API wrapper in nba_py
is a great start, but the documentation of the stats.nba.com API is lacking. nbastatsR
is an extremely valuable resource for the R community, and this work hopes to extend the breadth and depth of that package. In my research, I have also come across the recent effort of nba_api by swar. This looks similar to nba_py
and I am hoping to collaborate.
Goals
If successful, py_ball
should accomplish the following:
- By working with the community, improve the quality of documentation for stats.nba.com.
- Further enable the dissemination of basketball statistics to increase the understanding of the sport and encourage the practice of basketball analytics.
- Produce introductory analyses leveraging NBA and WNBA data to reduce the barrier of entry to basketball analytics through demonstration.
- Focus on the WNBA in an effort to stress inclusivity and contribute to women's basketball analytics.
Documentation
While nba_api
improves greatly upon the documentation of the stats.nba.com API in nba_py
, py_ball
strives to take documentation further through the following:
- Fully documented code, including function, class, and script docstrings.
- Extend endpoint and parameter documentation to include feature definitions.
Current Documentation
Classes
Development
Initially map stats.nba.com API and fully document code.Refactor code to generate a more consistent structure across classes.Document endpoints and parameters with definitions.(See Wiki here)- Research other basketball-related APIs to map.
Write unit tests for the package.- Begin introductory basketball analytics analyses.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.