A client for the lichess.org API
Project description
This is a client library for the lichess.org API. It is designed to be:
Easy to use
Customizable when you need it
Adaptable to API changes
Easy to integrate with python-chess
Have a look at some short examples. For more, check out the full documentation.
Getting a user’s rating:
>>> import lichess.api >>> >>> user = lichess.api.user('thibault') >>> print(user['perfs']['blitz']['rating']) 1617
Checking who’s online and playing:
>>> import lichess.api >>> >>> users = list(lichess.api.users_status(['thibault', 'cyanfish'])) >>> online = [u['id'] for u in users if u.get('online')] >>> playing = [u['id'] for u in users if u.get('playing')] >>> print(online, playing) ['thibault', 'cyanfish'] ['cyanfish']
Saving a PGN of a user’s last 200 games:
>>> import lichess.api >>> from lichess.format import SINGLE_PGN >>> >>> pgn = lichess.api.user_games('thibault', max=200, format=SINGLE_PGN) >>> with open('last200.pgn', 'w') as f: >>> f.write(pgn)
Integrating with python-chess:
>>> import lichess.api >>> from lichess.format import PYCHESS >>> >>> game = lichess.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 python-lichess
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
python-lichess-0.9.tar.gz
(7.5 kB
view hashes)
Built Distribution
Close
Hashes for python_lichess-0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e33ae713d316fc52b2470fe9fd786b02bd7ea7a1310192029576bd466f09002d |
|
MD5 | 72d8478cb2e1ea5dda7642b1eb7d5e4b |
|
BLAKE2b-256 | 23076cfaa4ef2649d705defc3e7c8ff7ed3a3bb467400325d00ad9da3acedf39 |