ESPN API
This package uses ESPN’s Fantasy API to extract data from any public or private league for Fantasy Football and Basketball (NHL, MLB, and WNBA are in development).
Please feel free to make suggestions, bug reports, and pull request for features or fixes!
This package was inspired and based off of rbarton65/espnff.
Installing
Note
For contributors, please refer to the development section.
Latest release with pip:
pip install espn_api
Clone from source with Git and uv:
git clone https://github.com/cwendt94/espn-api
cd espn-api
uv sync
Development
This project’s development tooling uses uv as the dependency/environment manager, in order to create an easy, reproducible development workflow. With uv installed, run uv sync --extra dev at the root of your clone to setup the dev environment. The formatter needs Python 3.10+.
Tests
uv run pytest tests --ignore-glob='**/integration/**'
Omit the --ignore-glob option to run all tests(including those that hit live ESPN).
uv run black espn_api tests
Type check
uv run mypy espn_api
Usage
# Football API
from espn_api.football import League
# Basketball API
from espn_api.basketball import League
# Hockey API
from espn_api.hockey import League
# Baseball API
from espn_api.baseball import League
# Init
league = League(league_id=222, year=2019)
If you have any questions about the package, ESPN API data, or want to talk about a feature please start a discussion!
Issue Reporting
If you find a bug follow the steps below for reporting.
-
Open a new issue with a brief description of the bug for the title. In the title also add which sport (Football or Basketball)
-
Run the application in debug mode to view ESPN API request’s and response’s
# ... import statement above
league = League(league_id=1245, year=2019, debug=True)
The application will print all requests and the response from ESPN’s API in the console. I would suggest piping the console output to a text file as it will be a lot of data.
-
Find the last log before the crash and copy it in the issue descrption with the line number of the crash or possible bug.
-
Submit the new issue!
I will try to comment on the issue as soon as possible with my thoughts and possible fix!
评论