Skip to main content

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

Project description

Lichess Python SDK

This package is meant to be an unofficial Python API Client for lichess.org.
For information about the API please refer to https://lichess.org/api
Every API endpoint uses async Python methods (asyncio).

Installation

Pypi: pip install async-lichess-sdk

Test Pypi: pip install -i https://test.pypi.org/simple/ async-lichess-sdk

Documentation

Auto generated documentation

Sample Notebook

Notebook with all methods

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 and usage

import asyncio
from lichess_client import APIClient


async def main():
    client = APIClient(token="your_lichess_account_token")
    response = await client.account.get_my_profile()
    print(response)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

.....

{'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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for async-lichess-sdk, version 1.1.0.6
Filename, size File type Python version Upload date Hashes
Filename, size async_lichess_sdk-1.1.0.6-py3-none-any.whl (54.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size async_lichess_sdk-1.1.0.6.tar.gz (24.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page