Giter Club home page Giter Club logo

lichess_python_sdk's Introduction

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}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.