Skip to content

JeffreyWardman/chesscom

Repository files navigation

Chess.com Python API

Python 3.7+ License: MIT PyPI Status Downloads

Unofficial Chess.com Python API and toolkit.

This Python API is a wrapper to the PubAPI (a read-only REST API that responds with JSON-LD data).

Install

Install from PyPi:

python3 -m pip install chesscom

Install locally

git clone [email protected]:jeffreywardman/chesscom.git
cd chesscom
python3 -m pip install -e .

To Do

General

  • Set up GitHub Actions
  • API usage examples

API

  • Documentation
    • Read the Docs
  • Abstraction for similar data classes.

Toolkit

  • Plot by piece type
  • Plot piece coverage
  • Create game GIFs

Contributing

Please ensure PRs have the following formats:

  • Code formatter: Black
  • Docstrings: Google

Final Comments

I will continue to maintain this repository so issues and pull requests are very much welcome!

Feel free to add me (jeffreywardman) on chess.com so we can play sometime!

If you'd like to register for a premium subscription to Chess.com, please feel free to use my affiliate link: https://www.chess.com/membership?ref_id=41653954

About

Chess.com unofficial python API and toolkit

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published