async-lichess-sdk 1.1.0.1

Asynchronous Python API client for accessing the lichess.org API.

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/lichees_python_SDK/html/index.html

Sample Notebook

https://github.com/amasend/lichees_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}