Python Wrapper for Chess.com API
Project description
Python wrapper for Chess.com Public API
Python wrapper for Chess.com API which provides public data from the chess.com website. All endpoints provided by Chess.com's API are available in the respectively named methods.
Installation
The package requires Python 3.7 or higher.
Install latest version from PyPI: pip install chess.com
Resources
- Documentation: readthedocs.org
- Published-Data API: chess.com
Usage
Retrieving Data
All the functions return a ChessDotComResponse
object. The data can be accessed in dictionary format or via attributes.
All functions can be made asynchronous. The package uses aiohttp to send requests to the API.
Synchronous
from chessdotcom import get_player_profile
response = get_player_profile("fabianocaruana")
player_name = response.json['player']['name']
#or
player_name = response.player.name
Asynchronous
from asyncio import gather
from chessdotcom.aio import get_player_profile, Client
#or
from chessdotcom import get_player_profile, Client
Client.aio = True
usernames = ["fabianocaruana", "GMHikaruOnTwitch", "MagnusCarlsen", "GarryKasparov"]
cors = [get_player_profile(name) for name in usernames]
responses = Client.loop.run_until_complete(gather(*cors))
important: The API will begin to rate limit the client if too many requests are made at once.
Configuring the Client object
Headers and and other request parameters can be set through the Client
object. Official Chess.com documentation recommends adding a User-Agent
header.
#optional
from chessdotcom import Client
Client.config["headers"]["User-Agent"] = (
"My Python Application. "
"Contact me at email@example.com"
)
All the methods from the module will now include the header when making a request to the API.
Contact
- Email me at saradzhyanatur@gmail.com or open a new Issue on Github.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chess.com-1.7.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc8f30022f89de3bd1c45056b2edf9ce7c8a343e8ba42aa6e96aaa3ca5dd107c |
|
MD5 | 5429975c279b872d7701f41abcc13ac2 |
|
BLAKE2b-256 | b4048e4be29d6cd2bddc3c568c93cb007d38eb4a1b9f5d8b6be5df6fcfc74cb4 |