Skip to main content

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.

Source Distribution

berserk-0.1.1.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

berserk-0.1.1-py2.py3-none-any.whl (10.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file berserk-0.1.1.tar.gz.

File metadata

  • Download URL: berserk-0.1.1.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for berserk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b3a5f7f4833f9d3d52c2af496caf37eb340e35fd02e81b3a3167471c5222d4c4
MD5 c570a98af7f4e3d664231af01b48b415
BLAKE2b-256 3da3a4daee5dcc358e20b3442ca984f3a2ce4d464daef5d4d870cb6f591f2036

See more details on using hashes here.

File details

Details for the file berserk-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for berserk-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 756b72abe8f36c627eed453c27ffac9d91dda7df8a905379194356dcc4f7233c
MD5 4e02c3deab752dcfe9e6f8b0a3c26bd5
BLAKE2b-256 a2d1710624d80d2c04aee50743fbb76896e599ef057c183c8ed9e74a1bd61358

See more details on using hashes here.

Supported by

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