Skip to content

dtsong/sleeper-api-wrapper

Repository files navigation

GitHub GitHub issues PyPI

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
  2. Installation
  3. Documentation
  4. Notes
  5. Dependencies
  6. License

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

Install

pip install sleeper-api-wrapper

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, but full documentation for the Python objects and their methods can be found in the docs folder. There are some bespoke methods for transforming the data into more useful structures in addition to the methods that directly call the API.

Notes

This package is intended to be used by Python version 3.8 and higher. There might be some wacky results for previous versions.

Dependencies

requests

  • Used for all http requests in sleeper_wrapper

pytest

  • Used for all testing in sleeper_wrapper

License

This project is licensed under the terms of the MIT license.