Asynchronous Python API client for accessing the lichess.org API.
Project description
This package is meant to be an unofficial Python API Client for lichees.org.
For information about the API please refer to https://lichess.org/api
Every API endpoint uses async Python methods (asyncio).
Documentation
https://amasend.github.io/lichess_python_SDK/html/index.html
Sample Notebook
https://github.com/amasend/lichess_python_SDK/blob/master/sample_notebooks/How%20to%20use%20an%20Asynchronous%20Lichess%20Python%20Client.ipynb
Dependencies
To use this package you need to install all of the dependencies located under requirements.txt
.
pip install requirements.txt
Supported python versions: python >= 3.6
How to build
Building script is located under build.sh
.
Steps:
sh build.sh
pip install -U .
Implemented Lichess Endpoints
- account
- boards
- bots
- broadcast
- challenges
- games
- messages
- relations
- simulations
- studies
- teams
- tournaments
- users
Sample usage
Client initialization
from lichess_client import APIClient
client = APIClient(token="lichess_account_token")
Call an endpoint
response = await client.account.get_my_profile()
print(response)
{'metadata':
{'method': <RequestMethods.GET: 'GET'>,
'url': 'https://lichess.org/api/account/kid',
'content_type': 'application/json',
'timestamp': b'Fri, 13 Mar 2020 19:05:27 GMT'},
'entity':
{'code': 200,
'reason': 'OK',
'status': <StatusTypes.SUCCESS: 'success'>,
'content': {'kid': False}
}
}
Access to the response properties
print(response.metadata.timestamp)
b'Fri, 13 Mar 2020 19:11:32 GMT'
print(response.entity.content)
{'kid': False}
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 async_lichess_sdk-1.1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4aed681aeec97b9e3b1305d4adc554e010cddb4d435c80d303c7611bbde7afdf |
|
MD5 | 4f9d15ef030beef14c651f4db1f39e1d |
|
BLAKE2b-256 | 9fcd06b6e8a09ae275637128d1e5aaaa19bf6d5afc3837837cd63b6db214053a |
Hashes for async_lichess_sdk-1.1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a3b7193f8a2d432d1e2a73f7fa8e97f96fe9dec94745c234c0000c3a8d6638c |
|
MD5 | 71d8e43b3ad8c7cf0b2d8b5b26464a75 |
|
BLAKE2b-256 | 2bb44b82c5a8455f066a4807589be8a81779cf2b0b41091f3a4cd29d5c31f71d |