Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Python client for the lichess API

Project description

berserk

https://img.shields.io/pypi/v/berserk.svg https://img.shields.io/travis/rhgrant10/berserk.svg Documentation Status

Python client for the lichess API

Features

  • handles JSON and PGN formats at user’s discretion
  • all endpoints implemented
  • token auth support provided
  • easy integration with oauth2

Usage

You can use any requests.Session-like object as a session, including those from requests_oauth. A simple token session is included, as shown below:

import berserk


session = berserk.TokenSession('token')
lichess = berserk.Client(session)

lichess.account.get() lichess.account.get_email() lichess.account.get_preferences() lichess.account.get_kid_mode() lichess.account.set_kid_mode() lichess.account.upgrade_to_bot()

lichess.users.get_realtime_statuses() lichess.users.get_all_top_10() lichess.users.get_leaderboard() lichess.users.get_public_data() lichess.users.get_activity_feed() lichess.users.get_by_id() lichess.users.get_by_team() lichess.users.get_live_streamers()

lichess.games.export() lichess.games.export_by_player() lichess.games.export_multi() lichess.games.get_among_players() lichess.games.get_ongoing() lichess.games.get_tv_channels()

lichess.bots.stream_incoming_events() lichess.bots.stream_game_state() lichess.bots.make_move() lichess.bots.post_message() lichess.bots.abort_game() lichess.bots.resign_game() lichess.bots.accept_challenge() lichess.bots.decline_challenge()

lichess.tournaments.get() lichess.tournaments.create()

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.1 (2018-07-14)

  • Added tests for session and formats modules
  • Fixed mispelled PgnHandler class (!)
  • Fixed issue with trailing whitespace when splitting multiple PGN texts
  • Fixed the usage overview in the README
  • Fixed the versions for travis-ci
  • Made it easier to test the JsonHandler class
  • Salted the bumpversion config to taste

0.1.0 (2018-07-10)

  • First release on PyPI.

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 berserk, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size berserk-0.1.1-py2.py3-none-any.whl (10.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size berserk-0.1.1.tar.gz (20.5 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