Skip to main content

A free and open source chess improvement app that combines the power of lichess and anki

Project description

Thumbnail

A free and open-source chess improvement app that combines the power of Lichess and Anki.

Chessli
Project GitHub Repo stars GitHub code size in bytes Lines of code
Activity & Issue Tracking GitHub last commit GitHub issues GitHub closed issues
PyPI PyPI PyPI - Python Version Downloads
Build & Health GitHub Workflow Status Codecov
Docs Documentation Status Tutorial
News & Updates Twitter Follow GitHub followers

Demos

CLI Demo (watch whole video on Youtube)

CLI DEMO GIF

Anki Cards Demo (watch whole video on Youtube)

CLI CARDS GIF

Documentation

Check out the documentation:

Tutorial
Setup chessli How to set chessli up
Games & Mistakes How to learn from your games
Openings How to build an opening repertoire
Tactics How to get better at tactics
Anki Cards How to use chessli's anki cards

Features

  • Automatically fetch your games and played tactics puzzles from lichess via the berserk python client for the Lichess API.!
  • Find your mistakes by parsing your games and analysing them with python-chess.
  • Build a simple opening repertoire and list your known openings
  • Spaced repetition & Retrieval Practice: Automatically (via apy) or manually (via csv export) add your game mistakes, your openings and your tackled lichess puzzles into Anki
  • Stats and visualizations: Seamlessly show lichess leaderboards or plot your rating history.

Getting Started

Installation

  1. Install pip. See here for help.

  2. Install chessli with pip:

pip install chessli

That's it!

Basic Usage

To get help about chesslis commands, open your console and type:

chessli --help

The same works for subcommands, e.g., :

chessli games --help

You can find an overview of all availabe cli-commands here in the docs.

Tutorial

Now as you are familiar with the basics, you might want to walk through the tutorial to get the most out of chessli! Start with setting up chessli.

Acknowledgments

Acknowledgements
Lichess A free, no-ads, open source chess server that let's everyone play chess! Think about whether to become a patron! :)
Anki A free and open-source flashcard program using spaced-repetition, a technique from cognitive science for fast and long-lasting memorization. I couldn't imagine learning without it anymore.
Anki Card Templates The interactive chess functionality on Chessli's anki cards is based from these fantastic cards.
python-chess Most of the heavy lifting, e.g. parsing games, finding mistakes, extracting openings, etc. is done with python-chess.
berserk The communication between lichess and chessli is performed via berserk
typer The chessli cli is built with the great typer
rich The rich colors and fancy tables are made possible by rich
apy Importing cards directly into anki without csv-export can be done via apy

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

chessli-0.2.4.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

chessli-0.2.4-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file chessli-0.2.4.tar.gz.

File metadata

  • Download URL: chessli-0.2.4.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-66-generic

File hashes

Hashes for chessli-0.2.4.tar.gz
Algorithm Hash digest
SHA256 4af3f14e6c83694e7bb6fd7cfaf7dadeda5bb09e7eda24a439c05497bdbe5f15
MD5 bff25cab87968ae629fb5fcfed354e05
BLAKE2b-256 92de86201cbac5f39f423fe688f658fb228a42dec76483f287b978ae232a98e5

See more details on using hashes here.

File details

Details for the file chessli-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: chessli-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-66-generic

File hashes

Hashes for chessli-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1ae8134dc560de697c0824cc0b1147c3447cea3b64ae962dc00c2d9701c4b335
MD5 8e52e1680bd8bf776e9a748578ce154f
BLAKE2b-256 2b7139ad3136bc2757751caceba9a10f6f1821ffde4865a4e604db1d399e2585

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