![Thumbnail](https://github.com/pwenker/chessli/blob/main/imgs/chessli.png?raw=true)
A free and open-source chess improvement app that combines the power of Lichess and Anki.
| Chessli |
---|
Project | ![Lines of code](https://img.shields.io/tokei/lines/github/pwenker/chessli) |
Activity & Issue Tracking | ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/pwenker/chessli) |
PyPI | ![Downloads](https://pepy.tech/badge/chessli/month) |
Build & Health | ![Codecov](https://img.shields.io/codecov/c/github/pwenker/chessli) |
Docs | ![Tutorial](https://img.shields.io/badge/Tutorial-active-brightgreen) |
News & Updates | ![GitHub followers](https://img.shields.io/github/followers/pwenker?style=social) |
Demos
CLI Demo (watch whole video on Youtube)
![CLI DEMO GIF](https://github.com/pwenker/chessli/blob/main/imgs/chessli_cli_demo.gif?raw=true)
Anki Cards Demo (watch whole video on Youtube)
![CLI CARDS GIF](https://github.com/pwenker/chessli/blob/main/imgs/chessli_cards_demo.gif?raw=true)
Documentation
Check out the documentation:
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
-
Install pip
. See here for help.
-
Install chessli with pip
:
pip install chessli
That's it!
Basic Usage
To get help about chessli
s 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 |