Skip to main content

Python wrapper for lichess

Project description

A client for the lichess.org API

This is a client library for the Lichess API. It is designed to be:

  • Easy to use

  • Customizable when you need it

  • Adaptable to API changes

Getting a user's rating:

>>> import lichesspy.api
>>> 
>>> user = lichesspy.api.user('thibault')
>>> print(user['perfs']['blitz']['rating'])
1617

Checking who's online and playing:

>>> import lichesspy.api
>>>
>>> users = list(lichesspy.api.users_status(['thibault', 'cyanfish']))
>>> online = [u['id'] for u in users if u.get('online', False)]
>>> playing = [u['id'] for u in users if u.get('playing', False)]
>>> print(online, playing)
['thibault', 'cyanfish'] ['cyanfish']

Saving a PGN of a user's last 200 games:

>>> import lichesspy.api
>>> from lichesspy.format import SINGLE_PGN
>>> 
>>> pgn = lichesspy.api.user_games('thibault', max=200, format=SINGLE_PGN)
>>> with open('last200.pgn', 'w') as f:
>>>    f.write(pgn)

Integrating with lichesspy:

>>> import lichesspy.api
>>> from lichesspy.format import PYCHESS
>>> 
>>> game = lichesspy.api.game('Qa7FJNk2', format=PYCHESS)
>>> print(game.end().board())
. . k . R b r .
. p p r . N p .
p . . . . . . p
. . . . . . . .
. . . p . . . .
P . . P . . . P
. P P . . P P .
. . K R . . . .

Installing


pip install lichesspy

Farewell

Project details


Download files

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

Source Distribution

lichesspy-6.0.5.dev1.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

lichesspy-6.0.5.dev1-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file lichesspy-6.0.5.dev1.tar.gz.

File metadata

  • Download URL: lichesspy-6.0.5.dev1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for lichesspy-6.0.5.dev1.tar.gz
Algorithm Hash digest
SHA256 fc7d1cc474398745565def70446a5ec7666fe21448fb3267627a428383c3c84f
MD5 aba325541e748210fa5f203df41c80cf
BLAKE2b-256 a3513d2bfe8d94f5900b529dfcddda756e5e3bb1ce2ef395e62f7c3e4ff4378a

See more details on using hashes here.

File details

Details for the file lichesspy-6.0.5.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for lichesspy-6.0.5.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 23b8d45560acfc49cfa5dc21c3f041be9922668547e4918a78d56275be4a6317
MD5 3306be5b446795853c2d1c285c0ce0d9
BLAKE2b-256 e124ec0dfbb5a4f2783da17cf3ec04ac5354a810b5beb6ad4c3571b2ecddb6cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page