 [](https://codecov.io/gh/cwendt94/espn-api) [](https://gitter.im/ff-espn-api/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://badge.fury.io/py/espn-api)<a target="_blank" href="https://www.python.org/downloads/" title="Python version"><img src="https://img.shields.io/badge/python-%3E=_3.8-teal.svg"></a>
## 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](https://github.com/rbarton65/espnff).
## Installing
With Git:
```
git clone https://github.com/cwendt94/espn-api
cd espn-api
python3 setup.py install
```
With pip:
```
pip install espn_api
```
## Usage
### [For Getting Started and API details head over to the Wiki!](https://github.com/cwendt94/espn-api/wiki)
```python
# 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)
```
### Run Tests
```
python3 setup.py nosetests
```
## [Discussions](https://github.com/cwendt94/espn-api/discussions) (new)
If you have any questions about the package, ESPN API data, or want to talk about a feature please start a [discussion](https://github.com/cwendt94/espn-api/discussions)!
## Issue Reporting
If you find a bug follow the steps below for reporting.
1. Open a [new issue](https://github.com/cwendt94/espn-api/issues) with a brief description of the bug for the title. In the title also add which sport (Football or Basketball)
2. Run the application in debug mode to view ESPN API request's and response's
```python
# ... 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.
3. Find the last log before the crash and copy it in the issue descrption with the line number of the crash or possible bug.
4. Submit the new issue!
I will try to comment on the issue as soon as possible with my thoughts and possible fix!
Raw data
{
"_id": null,
"home_page": "https://github.com/cwendt94/espn-api",
"name": "espn-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Christian Wendt",
"author_email": "",
"download_url": "",
"platform": null,
"description": "\n [](https://codecov.io/gh/cwendt94/espn-api) [](https://gitter.im/ff-espn-api/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://badge.fury.io/py/espn-api)<a target=\"_blank\" href=\"https://www.python.org/downloads/\" title=\"Python version\"><img src=\"https://img.shields.io/badge/python-%3E=_3.8-teal.svg\"></a>\n\n\n## ESPN API\nThis 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)**. \nPlease feel free to make suggestions, bug reports, and pull request for features or fixes!\n\nThis package was inspired and based off of [rbarton65/espnff](https://github.com/rbarton65/espnff).\n\n## Installing\nWith Git:\n```\ngit clone https://github.com/cwendt94/espn-api\ncd espn-api\npython3 setup.py install\n```\nWith pip:\n```\npip install espn_api\n```\n\n## Usage\n### [For Getting Started and API details head over to the Wiki!](https://github.com/cwendt94/espn-api/wiki)\n```python\n# Football API\nfrom espn_api.football import League\n# Basketball API\nfrom espn_api.basketball import League\n# Hockey API\nfrom espn_api.hockey import League\n# Baseball API\nfrom espn_api.baseball import League\n# Init\nleague = League(league_id=222, year=2019)\n```\n\n### Run Tests\n```\npython3 setup.py nosetests\n```\n## [Discussions](https://github.com/cwendt94/espn-api/discussions) (new)\nIf you have any questions about the package, ESPN API data, or want to talk about a feature please start a [discussion](https://github.com/cwendt94/espn-api/discussions)! \n\n\n## Issue Reporting\nIf you find a bug follow the steps below for reporting.\n\n1. Open a [new issue](https://github.com/cwendt94/espn-api/issues) with a brief description of the bug for the title. In the title also add which sport (Football or Basketball)\n\n2. Run the application in debug mode to view ESPN API request's and response's\n ```python\n # ... import statement above\n league = League(league_id=1245, year=2019, debug=True)\n ```\n 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.\n\n3. Find the last log before the crash and copy it in the issue descrption with the line number of the crash or possible bug.\n\n4. Submit the new issue!\n\nI will try to comment on the issue as soon as possible with my thoughts and possible fix!\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "ESPN API",
"version": "0.34.1",
"project_urls": {
"Homepage": "https://github.com/cwendt94/espn-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac6a58ca370579e3d578f924f1295a3155222088a54cd3f42d0854375c90f744",
"md5": "59b65b4e6af235c7f9045c2caf5f885b",
"sha256": "f810da73bf625de34f9e84f57744e399d537c149a1b28aa248fe38124936c872"
},
"downloads": -1,
"filename": "espn_api-0.34.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59b65b4e6af235c7f9045c2caf5f885b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 63760,
"upload_time": "2023-12-29T16:55:29",
"upload_time_iso_8601": "2023-12-29T16:55:29.363791Z",
"url": "https://files.pythonhosted.org/packages/ac/6a/58ca370579e3d578f924f1295a3155222088a54cd3f42d0854375c90f744/espn_api-0.34.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 16:55:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cwendt94",
"github_project": "espn-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "espn-api"
}
JSON
