# sleeper-api-wrapper
A Python API wrapper for Sleeper Fantasy Sports, as well as tools to simplify data received. It makes all endpoints found in the Sleeper API docs: https://docs.sleeper.app/ available and turns the JSON response received into Python types for easy usage.
Ownership was transferred from @SwapnikKatkoori to @dtsong in March 2022 to continue efforts.
Original Repository: https://github.com/SwapnikKatkoori/sleeper-api-wrapper
# Table of Contents
1. [Project Roadmap](#roadmap)
2. [Installation](#install)
3. [Documentation](#documentation)
4. [Notes](#notes)
5. [Dependencies](#depends)
6. [License](#license)
<a name="roadmap"></a>
# Project Roadmap
* Establish solid CICD practices with automated testing and validation of pull requests via GitHub Actions
* Ensure libraries are up to date and secure.
* Update endpoints and logic with the current Sleeper API docs
* Investigate performance optimization (effort, implementation, etc)
Want to help? Send me a message to @dtsong
<a name="install"></a>
# Install
```
pip install sleeper-api-wrapper
```
<a name="documentation"></a>
# Documentation
There are five objects in the package that get data from the Sleeper API. Most of them are intuitive based on the [Sleeper API docs](https://docs.sleeper.com/), but full documentation for the Python objects and their methods can be found in the [`docs` folder](https://github.com/dtsong/sleeper-api-wrapper/tree/master/docs). There are some bespoke methods for transforming the data into more useful structures in addition to the methods that directly call the API.
<a name="notes"></a>
# Notes
This package is intended to be used by Python version 3.8 and higher. There might be some wacky results for previous versions.
<a name="depends"></a>
# Dependencies
[requests](https://github.com/kennethreitz/requests)
- Used for all http requests in sleeper_wrapper
[pytest](https://github.com/pytest-dev/pytest)
- Used for all testing in sleeper_wrapper
<a name="license"></a>
# License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/dtsong/sleeper-api-wrapper",
"name": "sleeper-api-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "fantasy football,fantasy sports,sports,sleeper fantasy,sleeper",
"author": "Dan Song, Ford Higgins",
"author_email": "py-sleeper-api-wrapper-maintainers@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/08/55/273105ec2b4751707dd3285770338fc86110bca4d3163557c61bf789ea58/sleeper_api_wrapper-1.1.0.tar.gz",
"platform": null,
"description": "\n\n\n# sleeper-api-wrapper\nA Python API wrapper for Sleeper Fantasy Sports, as well as tools to simplify data received. It makes all endpoints found in the Sleeper API docs: https://docs.sleeper.app/ available and turns the JSON response received into Python types for easy usage.\n\nOwnership was transferred from @SwapnikKatkoori to @dtsong in March 2022 to continue efforts.\nOriginal Repository: https://github.com/SwapnikKatkoori/sleeper-api-wrapper\n\n# Table of Contents\n1. [Project Roadmap](#roadmap)\n2. [Installation](#install)\n3. [Documentation](#documentation)\n4. [Notes](#notes)\n5. [Dependencies](#depends)\n6. [License](#license)\n\n<a name=\"roadmap\"></a>\n# Project Roadmap\n* Establish solid CICD practices with automated testing and validation of pull requests via GitHub Actions\n* Ensure libraries are up to date and secure.\n* Update endpoints and logic with the current Sleeper API docs\n* Investigate performance optimization (effort, implementation, etc)\n\nWant to help? Send me a message to @dtsong\n\n<a name=\"install\"></a>\n# Install\n```\npip install sleeper-api-wrapper\n```\n\n<a name=\"documentation\"></a>\n# Documentation\nThere are five objects in the package that get data from the Sleeper API. Most of them are intuitive based on the [Sleeper API docs](https://docs.sleeper.com/), but full documentation for the Python objects and their methods can be found in the [`docs` folder](https://github.com/dtsong/sleeper-api-wrapper/tree/master/docs). There are some bespoke methods for transforming the data into more useful structures in addition to the methods that directly call the API.\n\n<a name=\"notes\"></a>\n# Notes\nThis package is intended to be used by Python version 3.8 and higher. There might be some wacky results for previous versions.\n\n<a name=\"depends\"></a>\n# Dependencies\n\n[requests](https://github.com/kennethreitz/requests)\n- Used for all http requests in sleeper_wrapper\n\n[pytest](https://github.com/pytest-dev/pytest)\n- Used for all testing in sleeper_wrapper\n\n<a name=\"license\"></a>\n# License\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python API wrapper for Sleeper Fantasy sports, as well as tools to simplify received data.",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://github.com/dtsong/sleeper-api-wrapper/tree/master/docs",
"Homepage": "https://github.com/dtsong/sleeper-api-wrapper",
"Repository": "https://github.com/dtsong/sleeper-api-wrapper"
},
"split_keywords": [
"fantasy football",
"fantasy sports",
"sports",
"sleeper fantasy",
"sleeper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2adac422c4af3c47dc0b0931416776ab914a57b932bfadecd160d57d9e566a33",
"md5": "1bdff35cfccd59554e859f94a6ce2135",
"sha256": "f9925350e223391420326b5557cbba8c4b7fc42cd9f50d82f76daab94c160106"
},
"downloads": -1,
"filename": "sleeper_api_wrapper-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bdff35cfccd59554e859f94a6ce2135",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 10468,
"upload_time": "2024-02-06T19:29:55",
"upload_time_iso_8601": "2024-02-06T19:29:55.396946Z",
"url": "https://files.pythonhosted.org/packages/2a/da/c422c4af3c47dc0b0931416776ab914a57b932bfadecd160d57d9e566a33/sleeper_api_wrapper-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0855273105ec2b4751707dd3285770338fc86110bca4d3163557c61bf789ea58",
"md5": "dc179aaf3a9df61d9e346c29939e8759",
"sha256": "be6483dddfed2e1d2257a918f4270b0897cd5907bef9b9b49da8b588155b8787"
},
"downloads": -1,
"filename": "sleeper_api_wrapper-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "dc179aaf3a9df61d9e346c29939e8759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 8986,
"upload_time": "2024-02-06T19:29:56",
"upload_time_iso_8601": "2024-02-06T19:29:56.535485Z",
"url": "https://files.pythonhosted.org/packages/08/55/273105ec2b4751707dd3285770338fc86110bca4d3163557c61bf789ea58/sleeper_api_wrapper-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 19:29:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dtsong",
"github_project": "sleeper-api-wrapper",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sleeper-api-wrapper"
}
JSON
