save changes

.gitignore

@@ -0,0 +1,13 @@
+exploration
+data/
+
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

README.md

@@ -0,0 +1,15 @@
+# Welcome to Chessli2 🏰
+
+Chessli2 is your **always free** and **open-source** chess trainer 🛡️, designed to elevate your game by allowing you to analyze games, identify mistakes, and sharpen your tactics, all sourced directly from [lichess.org](https://lichess.org/).
+
+## Features 🌟
+
+- **Automatically fetch your games and played tactics puzzles** from lichess via the [berserk python client](https://github.com/lichess-org/berserk) for the Lichess API! 🔄
+- **Find your mistakes** by parsing and analyzing your games with [python-chess](https://github.com/niklasf/python-chess) 🔍
+- **Leverage the power of spaced repetition** using [Anki](https://apps.ankiweb.net/) with this amazing interactive chess template: [Anki-Chess-2.0](https://github.com/TowelSniffer/Anki-Chess-2.0) 🧠
+
+Chessli2 is here to support your journey to becoming a chess master. Dive in and start enhancing your skills today! 🚀
+
+## How to
+
+Coming soon...

pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "chessli2"
+version = "0.1.0"
+description = "Free and open-source chess trainer"
+authors = [
+    { name = "Pascal Wenker", email = "[email protected]" }
+]
+dependencies = [
+    "berserk>=0.13.2",
+    "pydantic-settings>=2.1.0",
+    "pydantic>=2.5.3",
+    "chess>=1.10.0",
+    "gradio_calendar>=0.0.4",
+    "gradio>=4.29.0",
+    "tabulate>=0.9.0",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true

requirements-dev.lock

@@ -0,0 +1,82 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+
+-e file:.
+aiofiles==23.2.1
+altair==5.2.0
+annotated-types==0.6.0
+anyio==4.2.0
+attrs==23.2.0
+berserk==0.13.2
+certifi==2023.11.17
+charset-normalizer==3.3.2
+chess==1.10.0
+click==8.1.7
+contourpy==1.2.0
+cycler==0.12.1
+deprecated==1.2.14
+fastapi==0.109.0
+ffmpy==0.3.1
+filelock==3.13.1
+fonttools==4.47.2
+fsspec==2023.12.2
+gradio==4.29.0
+gradio-calendar==0.0.4
+gradio-client==0.16.1
+h11==0.14.0
+httpcore==1.0.2
+httpx==0.26.0
+huggingface-hub==0.20.2
+idna==3.6
+importlib-resources==6.1.1
+jinja2==3.1.3
+jsonschema==4.20.0
+jsonschema-specifications==2023.12.1
+kiwisolver==1.4.5
+markdown-it-py==3.0.0
+markupsafe==2.1.3
+matplotlib==3.8.2
+mdurl==0.1.2
+ndjson==0.3.1
+numpy==1.26.3
+orjson==3.9.10
+packaging==23.2
+pandas==2.1.4
+pillow==10.2.0
+pydantic==2.5.3
+pydantic-core==2.14.6
+pydantic-settings==2.1.0
+pydub==0.25.1
+pygments==2.17.2
+pyparsing==3.1.1
+python-dateutil==2.8.2
+python-dotenv==1.0.0
+python-multipart==0.0.9
+pytz==2023.3.post1
+pyyaml==6.0.1
+referencing==0.32.1
+requests==2.31.0
+rich==13.7.0
+rpds-py==0.17.1
+ruff==0.4.3
+semantic-version==2.10.0
+shellingham==1.5.4
+six==1.16.0
+sniffio==1.3.0
+starlette==0.35.1
+tabulate==0.9.0
+tomlkit==0.12.0
+toolz==0.12.0
+tqdm==4.66.1
+typer==0.12.3
+typing-extensions==4.9.0
+tzdata==2023.4
+urllib3==2.1.0
+uvicorn==0.25.0
+websockets==11.0.3
+wrapt==1.16.0

requirements.lock

@@ -0,0 +1,82 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+
+-e file:.
+aiofiles==23.2.1
+altair==5.2.0
+annotated-types==0.6.0
+anyio==4.2.0
+attrs==23.2.0
+berserk==0.13.2
+certifi==2023.11.17
+charset-normalizer==3.3.2
+chess==1.10.0
+click==8.1.7
+contourpy==1.2.0
+cycler==0.12.1
+deprecated==1.2.14
+fastapi==0.109.0
+ffmpy==0.3.1
+filelock==3.13.1
+fonttools==4.47.2
+fsspec==2023.12.2
+gradio==4.29.0
+gradio-calendar==0.0.4
+gradio-client==0.16.1
+h11==0.14.0
+httpcore==1.0.2
+httpx==0.26.0
+huggingface-hub==0.20.2
+idna==3.6
+importlib-resources==6.1.1
+jinja2==3.1.3
+jsonschema==4.20.0
+jsonschema-specifications==2023.12.1
+kiwisolver==1.4.5
+markdown-it-py==3.0.0
+markupsafe==2.1.3
+matplotlib==3.8.2
+mdurl==0.1.2
+ndjson==0.3.1
+numpy==1.26.3
+orjson==3.9.10
+packaging==23.2
+pandas==2.1.4
+pillow==10.2.0
+pydantic==2.5.3
+pydantic-core==2.14.6
+pydantic-settings==2.1.0
+pydub==0.25.1
+pygments==2.17.2
+pyparsing==3.1.1
+python-dateutil==2.8.2
+python-dotenv==1.0.0
+python-multipart==0.0.9
+pytz==2023.3.post1
+pyyaml==6.0.1
+referencing==0.32.1
+requests==2.31.0
+rich==13.7.0
+rpds-py==0.17.1
+ruff==0.4.3
+semantic-version==2.10.0
+shellingham==1.5.4
+six==1.16.0
+sniffio==1.3.0
+starlette==0.35.1
+tabulate==0.9.0
+tomlkit==0.12.0
+toolz==0.12.0
+tqdm==4.66.1
+typer==0.12.3
+typing-extensions==4.9.0
+tzdata==2023.4
+urllib3==2.1.0
+uvicorn==0.25.0
+websockets==11.0.3
+wrapt==1.16.0

src/chessli2/games.py

@@ -0,0 +1,68 @@
+import io
+
+import berserk
+import chess.pgn
+import gradio as gr
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(env_file=".env")
+    lichess_api_token: str
+
+
+settings = Settings()
+
+def generate_grid_html(games_list, row_length=2):
+    game_ids = [
+        chess.pgn.read_headers(io.StringIO(game_pgn))["Site"].rpartition("/")[-1]
+        for game_pgn in games_list
+    ]
+    if row_length == 1:
+        return "\n".join(
+            [
+                f'<iframe src="https://lichess.org/embed/game/{game_id}?theme=auto&bg=auto" width=600 height=397 frameborder=0></iframe>'
+                for game_id in game_ids
+            ]
+        )
+    else:
+        html_rows = []
+        for i in range(0, len(game_ids), row_length):
+            row_html = "".join(
+                [
+                    f'<iframe src="https://lichess.org/embed/game/{id}?theme=auto&bg=auto" width="600" height="397" frameborder="0"></iframe>'
+                    for id in game_ids[i : i + row_length]
+                ]
+            )
+            # Wrap each row in a div for grid formatting
+            html_rows.append(
+                f'<div style="display: flex; justify-content: space-around;">{row_html}</div>'
+            )
+        return "\n".join(html_rows)
+
+def fetch_games(
+    user_name, start_date, end_date, lichess_api_token=settings.lichess_api_token
+):
+    gr.Info("Fetching chess games 🔄♟️")
+
+    start = berserk.utils.to_millis(start_date)
+    end = berserk.utils.to_millis(end_date)
+    session = berserk.TokenSession(lichess_api_token)
+    client = berserk.Client(session=session)
+    games = client.games.export_by_player(
+        user_name,
+        as_pgn=True,
+        color="black",
+        evals=True,
+        analysed=True,
+        literate=True,
+        since=start,
+        until=end,
+        opening=True,
+    )
+    games_list = list(games)
+
+
+    game_ids_html = generate_grid_html(games_list)
+
+    return games_list, gr.HTML(game_ids_html)

src/chessli2/gui.py

@@ -0,0 +1,125 @@
+from datetime import datetime
+from io import StringIO
+from pathlib import Path
+
+import chess.pgn
+import gradio as gr
+import pandas as pd
+from gradio_calendar import Calendar
+
+from chessli2.mistakes import validated_get_mistakes
+
+readme_file = Path("README.md")
+
+nags = {
+    "Mistake (?)": 2,
+    "Blunder (??)": 4,
+    "Speculative Move (!?)": 5,
+    "Dubious Move (?!)": 6,
+}
+
+with gr.Blocks() as demo:
+    with gr.Tab("Welcome"):
+        gr.Markdown(readme_file.read_text())
+    with gr.Tab("Games & Mistakes"):
+        gr.Markdown("Fetch your games and download a CSV with your mistakes")
+
+        lichess_api_token = gr.Textbox(
+            placeholder="Paste your Lichess API key",
+            label="Lichess API Token",
+            lines=1,
+            type="password",
+        )
+        user_name = gr.Textbox(
+            label="User Name",
+            placeholder="Enter your user name",
+            info="Type in your lichess user name",
+        )
+        with gr.Row():
+            start_date = Calendar(
+                type="datetime",
+                value=datetime.now(),
+                label="Select a start date",
+                info="Click the calendar icon to bring up the calendar.",
+            )
+            end_date = Calendar(
+                type="datetime",
+                value=datetime.now(),
+                label="Select an end date",
+                info="Click the calendar icon to bring up the calendar.",
+            )
+        nags_checkbox = gr.CheckboxGroup(
+            label="Mistake Types",
+            value=[2, 4],  # Mistakes and Blundes per default
+            info="Select which types of mistakes should be detected",
+            choices=[(k, v) for k, v in nags.items()],
+        )
+        get_mistakes_btn = gr.Button("Get Mistakes", variant="primary")
+
+        gr.Markdown("### Mistakes")
+        mistakes_df = gr.Dataframe(
+            headers=["PGN"],
+            visible=False,
+            interactive=False,
+        )
+        mistakes_md = gr.Markdown()
+
+        def export_csv(df, user_name):
+            gr.Info("Preparing downloadable CSV file 💾")
+            file_name = f"mistakes_{user_name}.csv"
+            df.to_csv(
+                file_name,
+                index=False,
+                header=False,
+            )
+            return gr.DownloadButton(value=file_name, visible=True)
+
+        download_button = gr.DownloadButton(
+            "Download CSV", variant="primary", visible=False
+        )
+
+        def df_to_md(df):
+            gr.Info("Visualizing mistakes as markdown table 📉📝")
+
+            def parse_pgn(pgn_text):
+                pgn_io = StringIO(pgn_text)
+                game = chess.pgn.read_game(pgn_io)
+                headers = game.headers
+                moves = pgn_text.split("\n\n")[1]
+                mistake, *correct_variation = moves.split("\n")
+                result_emoji = (
+                    "✅"
+                    if headers["Result"] == "1-0"
+                    else "❌"
+                    if headers["Result"] == "0-1"
+                    else "➖"
+                )
+                return {
+                    "White": headers["White"],
+                    "Black": headers["Black"],
+                    "Result": result_emoji,
+                    "White Elo": headers["WhiteElo"],
+                    "Black Elo": headers["BlackElo"],
+                    "Opening": headers["Opening"],
+                    "Mistake ❌": mistake,
+                    "Correct Variation ✅": correct_variation,
+                }
+
+            df_info = df["PGN"].apply(parse_pgn).apply(pd.Series)
+
+            return df_info.to_markdown(index=False)
+
+        get_mistakes_btn.click(
+            fn=validated_get_mistakes,
+            inputs=[lichess_api_token, user_name, start_date, end_date, nags_checkbox],
+            outputs=mistakes_df,
+            api_name="get_mistakes",
+        ).success(
+            fn=export_csv,
+            inputs=[mistakes_df, user_name],
+            outputs=download_button,
+        ).success(
+            fn=df_to_md,
+            inputs=mistakes_df,
+            outputs=mistakes_md,
+        )

src/chessli2/main.py

@@ -0,0 +1,5 @@
+from chessli2.gui import demo
+
+
+if __name__ == "__main__":
+    demo.launch(show_error=True)

src/chessli2/mistakes.py

@@ -0,0 +1,84 @@
+import io
+from enum import Enum
+
+import chess
+import chess.pgn
+import gradio as gr
+
+from chessli2.games import fetch_games
+
+
+class Color(Enum):
+    white = 1
+    black = 0
+
+
+def create_mistake_pgn(game_node):
+    parent = game_node.parent
+    game_root = game_node.game()
+
+    mistake_pgn = chess.pgn.Game()
+    mistake_pgn.headers = game_root.headers.copy()
+    mistake_pgn.setup(parent.parent.board())
+
+    mainline, *variations = parent.variations
+    assert len(variations) == 1
+    assert mainline.is_mainline()
+
+    vr = variations[0]
+
+    moves = [vr.parent.move, vr.move, *[n.move for n in vr.mainline()]]
+    mistake_pgn.add_line(
+        moves=moves,
+        starting_comment=f"{game_node.comment} (player's move was {game_node.san()})",
+    )
+
+    exporter = chess.pgn.StringExporter(headers=True, variations=True, comments=True)
+    pgn_string = mistake_pgn.accept(exporter)
+    return pgn_string
+
+
+def get_mistakes(lichess_api_token, user_name, start_date, end_date, nags):
+    games, _ = fetch_games(user_name, start_date, end_date, lichess_api_token)
+
+    gr.Info("Finding mistakes 🔍❌")
+    mistake_pgns = []
+    for game_pgn in games:
+        game_pgn = io.StringIO(game_pgn)
+        game_node = chess.pgn.read_game(game_pgn)
+
+        player: Color = (
+            Color.white if game_node.headers["White"] == user_name else Color.black
+        )
+
+        def was_players_move(game_node):
+            return player.value != game_node.turn()
+
+        def relevant_mistakes_were_made(game_node, nags):
+            return game_node.nags and game_node.nags.issubset(set(nags))
+
+        while game_node is not None:
+            if was_players_move(game_node) and relevant_mistakes_were_made(
+                game_node, nags
+            ):
+                mistake_pgn = create_mistake_pgn(game_node)
+
+                mistake_pgns.append(mistake_pgn)
+            game_node = game_node.next()
+            
+    return [[mp] for mp in mistake_pgns]
+
+
+def validate_user_input(user_name, start_date, end_date):
+    if not user_name.strip():
+        raise gr.Error("User name cannot be empty.")
+    if start_date > end_date:
+        raise gr.Error("Start date must be before end date.")
+    return user_name, start_date, end_date
+
+
+def validated_get_mistakes(lichess_api_token, user_name, start_date, end_date, nags):
+    user_name, start_date, end_date = validate_user_input(
+        user_name, start_date, end_date
+    )
+    return get_mistakes(lichess_api_token, user_name, start_date, end_date, nags)