pgn-clean-cg 0.0.0rc2__tar.gz

pgn_clean_cg-0.0.0rc2/CONTRIBUTING.rst

@@ -0,0 +1,132 @@
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+Contributing to pgn-clean-cg
+============================
+
+First of all, thank you for considering contributing to pgn-clean-cg.
+
+Before you open a pull request, please make sure that the code is correctly
+formatted, and you have not introduced any new linter errors.
+
+By submitting a pull request you certify that:
+
+* You are the author of the contribution, or have the legal right to submit it.
+* You either hold the copyright to the changes, or have the explicit legal
+  authorization to contribute them under this projects license.
+* You understand the code.
+* You accept full responsibility for it.
+
+Requirements
+------------
+
+In order to checkout the code and initialize the development environment you will need:
+
+* Git
+* Python 3
+* Pip
+* Automake
+
+These packages can be installed using your favourite package manager on Linux.
+
+Getting the code
+----------------
+
+This project is using Git, and is hosted on `Codeberg`_.
+
+.. code-block::
+
+   git clone ssh://git@codeberg.org/ehustad/pgn-cg-clean.git
+   cd pgn-clean-cg
+
+Initializing the development environment
+----------------------------------------
+
+The development environment can be initialized by using the make target "init"
+from the top level source directory. This will create a virtual environment using
+the Python venv module in .venv, install development tools, and install
+pgn-cg-clean in `editable mode`_.
+
+.. code-block::
+
+    make init
+
+The make targets "env", "install-dev-tools", and "install" can be used if you
+want to do this in stages. Note that "install" depends on "install-dev-tools"
+and both "install" and "install-dev-tools" depends on "env".
+
+To initialize the virtual environment, run the make target "env" from the top level
+source directory:
+
+.. code-block::
+
+    make env
+
+To install development tools, such as black, mypy, pylint, run the make target
+"install-dev-tools". Note that this requires the virtual environment in .venv
+to exist, as all packages will be installed to that virtual environment:
+
+.. code-block::
+
+    make install-dev-tools
+
+To install pgn-cg-clean in editable mode, run the make target "install" from the
+top level source directory:
+
+.. code-block::
+
+    make install
+
+Formatting code
+---------------
+
+The code can formatted by using the make target "format" from the top level
+source directory:
+
+.. code-block::
+
+    make format
+
+Running linters
+---------------
+
+The linters can be run using make the make target "lint" from the top level
+source directory:
+
+.. code-block::
+
+   make lint
+
+Running unit tests
+------------------
+
+The unit tests can be run using the make target "test" from the top level
+source directory:
+
+.. code-block::
+
+    make test
+
+Other make targets
+------------------
+
+Please run the make target "help" from the top level source directory, or see
+Makefile.
+
+.. code-block::
+
+    make help
+
+Creating a pull request
+-----------------------
+
+Please see the `Codeberg documentation`_.
+
+Thanks
+------
+
+Parts of this was based on the AI policy of the pip project.
+
+.. _Codeberg: https://codeberg.org/ehustad/pgn-cg-clean/
+.. _Codeberg documentation: https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/
+.. _editable mode: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

pgn_clean_cg-0.0.0rc2/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

pgn_clean_cg-0.0.0rc2/MANIFEST.in

@@ -0,0 +1,2 @@
+include tests/*.pgn
+include tests/*.pgn.license

pgn_clean_cg-0.0.0rc2/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: pgn-clean-cg
+Version: 0.0.0rc2
+Summary: Clean comments and Lichess computer analysis from pgn files
+Author-email: Espen Sandøy Hustad <espen@ehustad.com>
+License-Expression: MIT
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: chess
+Dynamic: license-file
+
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+pgn-clean-cg - A command line utility for removing Lichess computer analysis from pgn files
+===========================================================================================
+
+Are you tired of the computer spoiling all the fun before you even start to analyse your
+most recent chess game? Look no further, pgn-clean-cg is a command line utility for cleaning
+up pgn (Portable Game Notation) files.
+
+* Remove per move computer evaluation.
+* Remove per move comments, excluding clock times.
+* Remove variations, excluding the main variation.
+* Remove NAGs (Numeric Annotation Glyphs) such as ?, ??, !!, etc.
+
+Usage
+-----
+
+Run the command "pgn-clean-cg" on one or more .pgn (Portable Game Notation) and specify destination .pgn file.
+Example:
+
+.. code-block::
+
+    pgn-clean-cg input1.pgn input2.pgn out.pgn
+
+More verbose output can be added using the "-v" flag
+
+.. code-block::
+
+   pgn-clean-cg -v input1.pgn input2.pgn out.pgn
+
+The builtin help can be accessed using the "-h" flag
+
+.. code-block::
+
+    pgn-clean-cg -h
+
+Installation
+------------
+
+The following command install pgn-clean-cg from the `Python Package Index`_. You will need
+a working installation of Python3 and pip.
+
+.. code-block::
+
+   pip install --upgrade pgn-clean-cg
+
+Feedback and Contributing
+-------------------------
+Need help, or found a bug? Feel free to open an `issue`_ over on `Codeberg`_.
+
+If you want to get involved, please read `CONTRIBUTING.rst`_.
+
+.. _CONTRIBUTING.rst: https://codeberg.org/ehustad/pgn-cg-clean/src/branch/main/CONTRIBUTING.rst
+.. _issue: https://codeberg.org/ehustad/pgn-cg-clean/issues
+.. _Python Package Index: https://pypi.org/project/pgn-cg-clean/
+
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+Contributing to pgn-clean-cg
+============================
+
+First of all, thank you for considering contributing to pgn-clean-cg.
+
+Before you open a pull request, please make sure that the code is correctly
+formatted, and you have not introduced any new linter errors.
+
+By submitting a pull request you certify that:
+
+* You are the author of the contribution, or have the legal right to submit it.
+* You either hold the copyright to the changes, or have the explicit legal
+  authorization to contribute them under this projects license.
+* You understand the code.
+* You accept full responsibility for it.
+
+Requirements
+------------
+
+In order to checkout the code and initialize the development environment you will need:
+
+* Git
+* Python 3
+* Pip
+* Automake
+
+These packages can be installed using your favourite package manager on Linux.
+
+Getting the code
+----------------
+
+This project is using Git, and is hosted on `Codeberg`_.
+
+.. code-block::
+
+   git clone ssh://git@codeberg.org/ehustad/pgn-cg-clean.git
+   cd pgn-clean-cg
+
+Initializing the development environment
+----------------------------------------
+
+The development environment can be initialized by using the make target "init"
+from the top level source directory. This will create a virtual environment using
+the Python venv module in .venv, install development tools, and install
+pgn-cg-clean in `editable mode`_.
+
+.. code-block::
+
+    make init
+
+The make targets "env", "install-dev-tools", and "install" can be used if you
+want to do this in stages. Note that "install" depends on "install-dev-tools"
+and both "install" and "install-dev-tools" depends on "env".
+
+To initialize the virtual environment, run the make target "env" from the top level
+source directory:
+
+.. code-block::
+
+    make env
+
+To install development tools, such as black, mypy, pylint, run the make target
+"install-dev-tools". Note that this requires the virtual environment in .venv
+to exist, as all packages will be installed to that virtual environment:
+
+.. code-block::
+
+    make install-dev-tools
+
+To install pgn-cg-clean in editable mode, run the make target "install" from the
+top level source directory:
+
+.. code-block::
+
+    make install
+
+Formatting code
+---------------
+
+The code can formatted by using the make target "format" from the top level
+source directory:
+
+.. code-block::
+
+    make format
+
+Running linters
+---------------
+
+The linters can be run using make the make target "lint" from the top level
+source directory:
+
+.. code-block::
+
+   make lint
+
+Running unit tests
+------------------
+
+The unit tests can be run using the make target "test" from the top level
+source directory:
+
+.. code-block::
+
+    make test
+
+Other make targets
+------------------
+
+Please run the make target "help" from the top level source directory, or see
+Makefile.
+
+.. code-block::
+
+    make help
+
+Creating a pull request
+-----------------------
+
+Please see the `Codeberg documentation`_.
+
+Thanks
+------
+
+Parts of this was based on the AI policy of the pip project.
+
+.. _Codeberg: https://codeberg.org/ehustad/pgn-cg-clean/
+.. _Codeberg documentation: https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/
+.. _editable mode: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

pgn_clean_cg-0.0.0rc2/README.rst

@@ -0,0 +1,56 @@
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+pgn-clean-cg - A command line utility for removing Lichess computer analysis from pgn files
+===========================================================================================
+
+Are you tired of the computer spoiling all the fun before you even start to analyse your
+most recent chess game? Look no further, pgn-clean-cg is a command line utility for cleaning
+up pgn (Portable Game Notation) files.
+
+* Remove per move computer evaluation.
+* Remove per move comments, excluding clock times.
+* Remove variations, excluding the main variation.
+* Remove NAGs (Numeric Annotation Glyphs) such as ?, ??, !!, etc.
+
+Usage
+-----
+
+Run the command "pgn-clean-cg" on one or more .pgn (Portable Game Notation) and specify destination .pgn file.
+Example:
+
+.. code-block::
+
+    pgn-clean-cg input1.pgn input2.pgn out.pgn
+
+More verbose output can be added using the "-v" flag
+
+.. code-block::
+
+   pgn-clean-cg -v input1.pgn input2.pgn out.pgn
+
+The builtin help can be accessed using the "-h" flag
+
+.. code-block::
+
+    pgn-clean-cg -h
+
+Installation
+------------
+
+The following command install pgn-clean-cg from the `Python Package Index`_. You will need
+a working installation of Python3 and pip.
+
+.. code-block::
+
+   pip install --upgrade pgn-clean-cg
+
+Feedback and Contributing
+-------------------------
+Need help, or found a bug? Feel free to open an `issue`_ over on `Codeberg`_.
+
+If you want to get involved, please read `CONTRIBUTING.rst`_.
+
+.. _CONTRIBUTING.rst: https://codeberg.org/ehustad/pgn-cg-clean/src/branch/main/CONTRIBUTING.rst
+.. _issue: https://codeberg.org/ehustad/pgn-cg-clean/issues
+.. _Python Package Index: https://pypi.org/project/pgn-cg-clean/

pgn_clean_cg-0.0.0rc2/pgn_clean_cg/__init__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0
+
+__version__ = "0.0.0rc2"

pgn_clean_cg-0.0.0rc2/pgn_clean_cg/__main__.py

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+
+import sys
+
+from . import cli
+
+if __name__ == "__main__":
+    sys.exit(cli.main())

pgn_clean_cg-0.0.0rc2/pgn_clean_cg/cli.py

@@ -0,0 +1,100 @@
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+
+import argparse
+import sys
+
+from pathlib import Path
+
+from . import pgnutils
+
+
+class VerboseVisitor(pgnutils.BaseVisitor):
+    def begin_game(self, gameinfo: pgnutils.GameInfo):
+        print(
+            f"\tCleaning game: {gameinfo.date} - {gameinfo.players} - {gameinfo.result}"
+            f" in {gameinfo.opening}"
+        )
+
+
+def inputfile(filename: str) -> Path:
+    p = Path(filename)
+
+    if not p.is_file():
+        raise argparse.ArgumentTypeError(f"The file '{p}' does not exist.")
+
+    return p
+
+
+def outputfile(filename: str) -> Path:
+    p = Path(filename)
+
+    if p.is_dir():
+        raise argparse.ArgumentTypeError(f"'{p}' is a directory.")
+    return p
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(
+        prog="pgn-clean-cg",
+        description="Clean pgn files for comments, variations, and Lichess computer analysis.",
+    )
+
+    parser.add_argument(
+        "-v", "--verbose", action="store_true", help="Increase verbosity"
+    )
+
+    parser.add_argument(
+        "input",
+        type=inputfile,
+        metavar="INPUT_FILES",
+        nargs="+",
+        help="One or more input .pgn file(s)",
+    )
+    parser.add_argument(
+        "output", type=outputfile, metavar="OUTPUT_FILE", help="Output .pgn file"
+    )
+
+    args = parser.parse_args()
+
+    if args.output.exists():
+        overwrite = str(
+            input(
+                f"The file {args.output} already exists. Do you want to overwrite (y/N)?"
+            )
+        ).lower()
+        if overwrite != "y":
+            return 1
+
+    fixed_games = []
+    cg_cleaner = pgnutils.CGCleaner()
+
+    if args.verbose:
+        cg_cleaner.register_visitor(VerboseVisitor())
+
+    for file in args.input:
+        try:
+            with file.open() as f:
+                print(f"Cleaning file: '{file}'")
+                fixed_games.extend(cg_cleaner.clean(f))
+        except (OSError, PermissionError) as e:
+            skip = str(
+                input(f"Failed to open file: {e}. Do you want to skip file (Y/n)?")
+            ).lower()
+            if skip != "y":
+                return 1
+
+    try:
+        with args.output.open("w") as f:
+            for game in fixed_games:
+                print(game, file=f, end="\n\n")
+
+    except (OSError, PermissionError) as e:
+        print(f"Aborting: Failed to open file for writing: {e}.", file=sys.stderr)
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pgn_clean_cg-0.0.0rc2/pgn_clean_cg/pgnutils.py

@@ -0,0 +1,125 @@
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+
+from dataclasses import dataclass
+from typing import List, TextIO
+
+import chess.pgn
+
+
+def _extract_item_from_list(l: chess.pgn.Headers, item: str, default_value: str) -> str:
+    try:
+        return l[item]
+    except KeyError:
+        return default_value
+
+
+class CGCleaner:
+    def clean(self, pgn: TextIO) -> List[chess.pgn.Game]:
+        ret = []
+
+        while True:
+            game = chess.pgn.read_game(pgn)
+            if game is None:
+                break
+
+            ret.append(self._clean_game(game))
+
+        return ret
+
+    def register_visitor(self, visitor: BaseVisitor):
+        self.visitor = visitor
+
+    def _clean_game(self, game: chess.pgn.Game) -> chess.pgn.Game:
+        gameinfo = self._build_gameinfo(game)
+        self.visitor.begin_game(gameinfo)
+
+        for move in game.mainline():
+            move.nags = set()
+            clock = move.clock()
+            move.comment = ""
+            move.set_clock(clock)
+            self._clean_variations(move)
+
+        self.visitor.end_game(gameinfo)
+
+        return game
+
+    def _build_gameinfo(self, game: chess.pgn.Game) -> GameInfo:
+        white = Player(
+            _extract_item_from_list(game.headers, "White", "N.N"),
+            _extract_item_from_list(game.headers, "WhiteElo", ""),
+        )
+
+        black = Player(
+            _extract_item_from_list(game.headers, "Black", "N.N"),
+            _extract_item_from_list(game.headers, "BlackElo", ""),
+        )
+
+        opening = Opening(
+            _extract_item_from_list(game.headers, "ECO", ""),
+            _extract_item_from_list(game.headers, "Opening", "Unknown opening"),
+        )
+
+        return GameInfo(
+            Players(white, black),
+            _extract_item_from_list(game.headers, "Date", "unknown date"),
+            _extract_item_from_list(game.headers, "Result", "unknown result"),
+            opening,
+        )
+
+    def _clean_variations(self, move: chess.pgn.ChildNode):
+        if move.variations:
+            move.variations = move.variations[:1]
+
+    def __init__(self):
+        self.visitor = BaseVisitor()
+
+
+@dataclass
+class Player:
+    name: str
+    elo: str
+
+    def __repr__(self):
+        if self.elo:
+            return f"{self.name} ({self.elo})"
+
+        return self.name
+
+
+@dataclass
+class Players:
+    white: Player
+    black: Player
+
+    def __repr__(self):
+        return f"{self.white} vs {self.black}"
+
+
+@dataclass
+class Opening:
+    eco: str
+    name: str
+
+    def __repr__(self):
+        if self.eco:
+            return f"{self.eco}:{self.name}"
+
+        return self.name
+
+
+@dataclass
+class GameInfo:
+    players: Players
+    date: str
+    result: str
+    opening: Opening
+
+
+class BaseVisitor:
+    def begin_game(self, gameinfo: GameInfo):
+        pass
+
+    def end_game(self, gameinfo: GameInfo):
+        pass

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: pgn-clean-cg
+Version: 0.0.0rc2
+Summary: Clean comments and Lichess computer analysis from pgn files
+Author-email: Espen Sandøy Hustad <espen@ehustad.com>
+License-Expression: MIT
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: chess
+Dynamic: license-file
+
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+pgn-clean-cg - A command line utility for removing Lichess computer analysis from pgn files
+===========================================================================================
+
+Are you tired of the computer spoiling all the fun before you even start to analyse your
+most recent chess game? Look no further, pgn-clean-cg is a command line utility for cleaning
+up pgn (Portable Game Notation) files.
+
+* Remove per move computer evaluation.
+* Remove per move comments, excluding clock times.
+* Remove variations, excluding the main variation.
+* Remove NAGs (Numeric Annotation Glyphs) such as ?, ??, !!, etc.
+
+Usage
+-----
+
+Run the command "pgn-clean-cg" on one or more .pgn (Portable Game Notation) and specify destination .pgn file.
+Example:
+
+.. code-block::
+
+    pgn-clean-cg input1.pgn input2.pgn out.pgn
+
+More verbose output can be added using the "-v" flag
+
+.. code-block::
+
+   pgn-clean-cg -v input1.pgn input2.pgn out.pgn
+
+The builtin help can be accessed using the "-h" flag
+
+.. code-block::
+
+    pgn-clean-cg -h
+
+Installation
+------------
+
+The following command install pgn-clean-cg from the `Python Package Index`_. You will need
+a working installation of Python3 and pip.
+
+.. code-block::
+
+   pip install --upgrade pgn-clean-cg
+
+Feedback and Contributing
+-------------------------
+Need help, or found a bug? Feel free to open an `issue`_ over on `Codeberg`_.
+
+If you want to get involved, please read `CONTRIBUTING.rst`_.
+
+.. _CONTRIBUTING.rst: https://codeberg.org/ehustad/pgn-cg-clean/src/branch/main/CONTRIBUTING.rst
+.. _issue: https://codeberg.org/ehustad/pgn-cg-clean/issues
+.. _Python Package Index: https://pypi.org/project/pgn-cg-clean/
+
+.. SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+Contributing to pgn-clean-cg
+============================
+
+First of all, thank you for considering contributing to pgn-clean-cg.
+
+Before you open a pull request, please make sure that the code is correctly
+formatted, and you have not introduced any new linter errors.
+
+By submitting a pull request you certify that:
+
+* You are the author of the contribution, or have the legal right to submit it.
+* You either hold the copyright to the changes, or have the explicit legal
+  authorization to contribute them under this projects license.
+* You understand the code.
+* You accept full responsibility for it.
+
+Requirements
+------------
+
+In order to checkout the code and initialize the development environment you will need:
+
+* Git
+* Python 3
+* Pip
+* Automake
+
+These packages can be installed using your favourite package manager on Linux.
+
+Getting the code
+----------------
+
+This project is using Git, and is hosted on `Codeberg`_.
+
+.. code-block::
+
+   git clone ssh://git@codeberg.org/ehustad/pgn-cg-clean.git
+   cd pgn-clean-cg
+
+Initializing the development environment
+----------------------------------------
+
+The development environment can be initialized by using the make target "init"
+from the top level source directory. This will create a virtual environment using
+the Python venv module in .venv, install development tools, and install
+pgn-cg-clean in `editable mode`_.
+
+.. code-block::
+
+    make init
+
+The make targets "env", "install-dev-tools", and "install" can be used if you
+want to do this in stages. Note that "install" depends on "install-dev-tools"
+and both "install" and "install-dev-tools" depends on "env".
+
+To initialize the virtual environment, run the make target "env" from the top level
+source directory:
+
+.. code-block::
+
+    make env
+
+To install development tools, such as black, mypy, pylint, run the make target
+"install-dev-tools". Note that this requires the virtual environment in .venv
+to exist, as all packages will be installed to that virtual environment:
+
+.. code-block::
+
+    make install-dev-tools
+
+To install pgn-cg-clean in editable mode, run the make target "install" from the
+top level source directory:
+
+.. code-block::
+
+    make install
+
+Formatting code
+---------------
+
+The code can formatted by using the make target "format" from the top level
+source directory:
+
+.. code-block::
+
+    make format
+
+Running linters
+---------------
+
+The linters can be run using make the make target "lint" from the top level
+source directory:
+
+.. code-block::
+
+   make lint
+
+Running unit tests
+------------------
+
+The unit tests can be run using the make target "test" from the top level
+source directory:
+
+.. code-block::
+
+    make test
+
+Other make targets
+------------------
+
+Please run the make target "help" from the top level source directory, or see
+Makefile.
+
+.. code-block::
+
+    make help
+
+Creating a pull request
+-----------------------
+
+Please see the `Codeberg documentation`_.
+
+Thanks
+------
+
+Parts of this was based on the AI policy of the pip project.
+
+.. _Codeberg: https://codeberg.org/ehustad/pgn-cg-clean/
+.. _Codeberg documentation: https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/
+.. _editable mode: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+CONTRIBUTING.rst
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+pgn_clean_cg/__init__.py
+pgn_clean_cg/__main__.py
+pgn_clean_cg/cli.py
+pgn_clean_cg/pgnutils.py
+pgn_clean_cg.egg-info/PKG-INFO
+pgn_clean_cg.egg-info/SOURCES.txt
+pgn_clean_cg.egg-info/dependency_links.txt
+pgn_clean_cg.egg-info/entry_points.txt
+pgn_clean_cg.egg-info/requires.txt
+pgn_clean_cg.egg-info/top_level.txt
+tests/expected.pgn
+tests/expected.pgn.license
+tests/source.pgn
+tests/source.pgn.license
+tests/source_with_clk.pgn
+tests/source_with_clk.pgn.license
+tests/source_with_computer_eval.pgn
+tests/source_with_computer_eval.pgn.license
+tests/test_pgnutils.py

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pgn-clean-cg = pgn_clean_cg.cli:main

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/requires.txt

@@ -0,0 +1 @@
+chess

pgn_clean_cg-0.0.0rc2/pgn_clean_cg.egg-info/top_level.txt

@@ -0,0 +1 @@
+pgn_clean_cg

pgn_clean_cg-0.0.0rc2/pyproject.toml

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pgn-clean-cg"
+dynamic = [
+    "version",
+    "readme",
+]
+
+authors = [
+    {name = "Espen Sandøy Hustad", email = "espen@ehustad.com"},
+]
+description = "Clean comments and Lichess computer analysis from pgn files"
+license = "MIT"
+
+dependencies = [
+    "chess",
+]
+
+[dependency-groups]
+dev = [
+    "black",
+    "mypy",
+    "pylint",
+    "reuse",
+]
+
+[project.scripts]
+pgn-clean-cg = "pgn_clean_cg.cli:main"
+
+[tool.setuptools]
+packages = [
+    "pgn_clean_cg"
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "pgn_clean_cg.__version__"}
+readme = {file = ["README.rst", "CONTRIBUTING.rst"] }

pgn_clean_cg-0.0.0rc2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pgn_clean_cg-0.0.0rc2/tests/expected.pgn

@@ -0,0 +1,23 @@
+[Event "rated bullet game"]
+[Site "https://lichess.org/q3p2A91e"]
+[Date "2026.07.13"]
+[Round "-"]
+[White "tsunami10"]
+[Black "Secret_Magnus"]
+[Result "0-1"]
+[GameId "q3p2A91e"]
+[UTCDate "2026.07.13"]
+[UTCTime "13:34:00"]
+[WhiteElo "2964"]
+[BlackElo "3149"]
+[WhiteRatingDiff "-3"]
+[BlackRatingDiff "+3"]
+[BlackTitle "IM"]
+[Variant "Standard"]
+[TimeControl "60+0"]
+[ECO "B08"]
+[Opening "Pirc Defense: Classical Variation"]
+[Termination "Normal"]
+[Annotator "lichess.org"]
+
+1. Nf3 d6 2. d4 Nf6 3. Nc3 g6 4. e4 Bg7 5. e5 dxe5 6. dxe5 Qxd1+ 7. Nxd1 Ng4 8. Bf4 Nc6 9. Bb5 Bd7 10. Bxc6 Bxc6 11. e6 fxe6 12. Ne3 Nxe3 13. fxe3 Bxb2 14. Rb1 Bc3+ 15. Ke2 O-O-O 16. Ng1 Bxg2

pgn_clean_cg-0.0.0rc2/tests/expected.pgn.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0
+

pgn_clean_cg-0.0.0rc2/tests/source.pgn

@@ -0,0 +1,23 @@
+[Event "rated bullet game"]
+[Site "https://lichess.org/q3p2A91e"]
+[Date "2026.07.13"]
+[Round "-"]
+[White "tsunami10"]
+[Black "Secret_Magnus"]
+[Result "0-1"]
+[GameId "q3p2A91e"]
+[UTCDate "2026.07.13"]
+[UTCTime "13:34:00"]
+[WhiteElo "2964"]
+[BlackElo "3149"]
+[WhiteRatingDiff "-3"]
+[BlackRatingDiff "+3"]
+[BlackTitle "IM"]
+[Variant "Standard"]
+[TimeControl "60+0"]
+[ECO "B08"]
+[Opening "Pirc Defense: Classical Variation"]
+[Termination "Normal"]
+[Annotator "lichess.org"]
+
+1. Nf3 d6 2. d4 Nf6 3. Nc3 g6 4. e4 Bg7 5. e5 dxe5 6. dxe5 Qxd1+ 7. Nxd1 Ng4 8. Bf4 Nc6 9. Bb5 Bd7 (9... O-O 10. O-O (10. b3 h5) 10... Nd4) 10. Bxc6 Bxc6 11. e6 fxe6 12. Ne3 Nxe3 13. fxe3 Bxb2 (13... h5 14. Nd4 Bd7 (14... Rd8)) 14. Rb1 Bc3+ 15. Ke2 O-O-O 16. Ng1 Bxg2

pgn_clean_cg-0.0.0rc2/tests/source.pgn.license

@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0

pgn_clean_cg-0.0.0rc2/tests/source_with_clk.pgn

@@ -0,0 +1,25 @@
+[Event "Round 1: Perreard, Nicolas - Dlugosz, Jan"]
+[Site "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC/uPir5Hui"]
+[Date "2026.07.13"]
+[Round "1.7"]
+[White "Perreard, Nicolas"]
+[Black "Dlugosz, Jan"]
+[Result "1-0"]
+[WhiteElo "2041"]
+[WhiteFideId "1330861"]
+[BlackElo "1600"]
+[BlackFideId "545027633"]
+[Variant "Chess960"]
+[ECO "?"]
+[Opening "?"]
+[FEN "bbqrnnkr/pppppppp/8/8/8/8/PPPPPPPP/BBQRNNKR w KQkq - 0 1"]
+[SetUp "1"]
+[UTCDate "2026.07.13"]
+[UTCTime "07:57:24"]
+[BroadcastName "59th Biel International Chess Festival 2026 | Open | Free Style 960 (FSC)"]
+[BroadcastURL "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC"]
+[GameURL "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC/uPir5Hui"]
+
+1. d4 { [%eval 0.24] [%clk 0:58:15] } 1... d5 { [%eval 0.19] [%clk 0:59:12] } 2. b3 { [%eval 0.23] [%clk 0:57:33] } 2... Nf6?! { [%eval 0.87] } { Inaccuracy. c5 was best. } { [%clk 0:58:38] } 3. c4 { [%eval 0.74] [%clk 0:56:51] } 3... c6 { [%eval 0.9] [%clk 0:58:27] } 4. Nf3 { [%eval 0.77] [%clk 0:51:29] } 4... N8d7?! { [%eval 1.43] } { Inaccuracy. b6 was best. } { [%clk 0:56:42] } 5. Ne3 { [%eval 1.06] [%clk 0:50:22] } 5... e6 { [%eval 0.95] [%clk 0:56:29] } 6. h4 { [%eval 0.99] [%clk 0:44:11] } 6... h5 { [%eval 0.9] [%clk 0:54:47] } 7. Qa3 { [%eval 0.58] [%clk 0:42:58] } 7... g6 { [%eval 1.03] [%clk 0:52:36] } 8. Ng5 { [%eval 0.71] [%clk 0:41:42] } 8... Nh7 { [%eval 1.15] [%clk 0:51:16] } 9. Nxe6?! { [%eval 0.05] } { Inaccuracy. Qc1 was best. } { [%clk 0:36:21] } 9... fxe6 { [%eval 0.14] [%clk 0:51:23] } 10. Bxg6? { [%eval -1.27] } { Mistake. cxd5 was best. } { [%clk 0:36:48] } 10... Nhf8?? { [%eval 2.53] } { Blunder. Ndf6 was best. } { [%clk 0:50:11] } 11. Bd3?? { [%eval -0.83] } { Blunder. Qe7 was best. } { [%clk 0:36:54] } 11... Nf6 { [%eval -0.75] [%clk 0:49:51] } 12. Rh3 { [%eval -1.09] [%clk 0:30:45] } 12... Kf7? { [%eval 0.04] } { Mistake. Qc7 was best. } { [%clk 0:49:06] } 13. Rf3 { [%eval 0.07] [%clk 0:30:37] } 13... Bd6? { [%eval 1.2] } { Mistake. Ng6 was best. } { [%clk 0:48:42] } 14. Qxa7?! { [%eval 0.22] } { Inaccuracy. Qc1 was best. } { [%clk 0:30:36] } 14... Ke7 { [%eval 0.76] [%clk 0:48:19] } 15. c5 { [%eval 0.74] [%clk 0:29:15] } 15... Bb8 { [%eval 1.14] [%clk 0:48:38] } 16. Qa3 { [%eval 1.11] [%clk 0:29:28] } 16... N8d7 { [%eval 1.09] [%clk 0:47:58] } 17. O-O-O?! { [%eval 0.0] } { Inaccuracy. g3 was best. } { [%clk 0:29:42] } 17... Bc7 { [%eval 0.0] [%clk 0:48:07] } 18. b4?! { [%eval -0.8] } { Inaccuracy. Kb1 was best. } { [%clk 0:27:36] } 1-0
+
+

pgn_clean_cg-0.0.0rc2/tests/source_with_clk.pgn.license

@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0

pgn_clean_cg-0.0.0rc2/tests/source_with_computer_eval.pgn

@@ -0,0 +1,26 @@
+[Event "Round 1: Brixius, Dirk - Cherniaev, Alexander"]
+[Site "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC/Yc5uWTEm"]
+[Date "2026.07.13"]
+[Round "1.2"]
+[White "Brixius, Dirk"]
+[Black "Cherniaev, Alexander"]
+[Result "0-1"]
+[WhiteElo "1821"]
+[WhiteFideId "12909734"]
+[BlackElo "2275"]
+[BlackTitle "GM"]
+[BlackFideId "4117301"]
+[Variant "Chess960"]
+[ECO "?"]
+[Opening "?"]
+[FEN "bbqrnnkr/pppppppp/8/8/8/8/PPPPPPPP/BBQRNNKR w KQkq - 0 1"]
+[SetUp "1"]
+[UTCDate "2026.07.13"]
+[UTCTime "07:57:24"]
+[BroadcastName "59th Biel International Chess Festival 2026 | Open | Free Style 960 (FSC)"]
+[BroadcastURL "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC"]
+[GameURL "https://lichess.org/broadcast/59th-biel-international-chess-festival-2026-open-free-style-960-fsc/round-1/hxv9N3yC/Yc5uWTEm"]
+
+1. c4 { [%eval 0.35] [%clk 1:00:30] } 1... c5 { [%eval 0.15] [%clk 0:59:43] } 2. b3 { [%eval 0.11] [%clk 0:59:02] } 2... b6 { [%eval 0.23] [%clk 1:00:06] } 3. d4 { [%eval -0.06] [%clk 0:57:43] } 3... cxd4 { [%eval 0.21] [%clk 1:00:19] } 4. Bxd4 { [%eval 0.15] [%clk 0:57:21] } 4... Ne6 { [%eval 0.13] [%clk 1:00:31] } 5. e3?! { [%eval -0.68] } { Inaccuracy. Bb2 was best. } { [%clk 0:56:54] } 5... Nxd4 { [%eval -0.71] [%clk 1:00:44] } 6. exd4 { [%eval -0.71] [%clk 0:56:41] } 6... e6 { [%eval -0.69] [%clk 1:00:29] } 7. Qe3 { [%eval -0.99] [%clk 0:54:52] } 7... Nf6 { [%eval -1.04] [%clk 1:00:36] } 8. Nf3 { [%eval -0.96] [%clk 0:52:12] } 8... Qc7 { [%eval -0.73] [%clk 0:54:12] } 9. Ng3 { [%eval -1.03] [%clk 0:49:29] } 9... Qf4 { [%eval -0.75] [%clk 0:47:00] } 10. Ne2 { [%eval -0.87] [%clk 0:45:11] } 10... Qxe3 { [%eval -0.79] [%clk 0:42:56] } 11. fxe3 { [%eval -0.84] [%clk 0:45:38] } 11... O-O { [%eval -0.79] [%clk 0:43:12] } 12. Nc3 { [%eval -0.78] [%clk 0:42:47] } 12... Rc8 { [%eval -0.76] [%clk 0:32:31] } 13. e4 { [%eval -0.72] [%clk 0:40:55] } 13... d5 { [%eval -0.86] [%clk 0:25:26] } 14. e5 { [%eval -1.06] [%clk 0:37:20] } 14... Nd7?! { [%eval -0.33] } { Inaccuracy. Nh5 was best. } { [%clk 0:24:52] } 15. Bd3 { [%eval -0.22] [%clk 0:35:28] } 15... f6 { [%eval -0.4] [%clk 0:23:40] } 16. cxd5?! { [%eval -1.4] } { Inaccuracy. Nxd5 was best. } { [%clk 0:34:23] } 16... exd5? { [%eval 0.03] } { Mistake. Rxc3 was best. } { [%clk 0:24:05] } 17. e6?? { [%eval -1.69] } { Blunder. Bf5 was best. } { [%clk 0:34:20] } 17... Rxc3 { [%eval -1.75] [%clk 0:24:23] } 18. exd7 { [%eval -1.77] [%clk 0:34:35] } 18... Bc6 { [%eval -1.8] [%clk 0:17:37] } 19. Kf2 { [%eval -1.59] [%clk 0:34:00] } 19... Bxd7 { [%eval -1.66] [%clk 0:17:52] } 20. Rhe1 { [%eval -1.79] [%clk 0:32:27] } 20... Bd6 { [%eval -1.82] [%clk 0:18:03] } 21. g3 { [%eval -2.39] [%clk 0:27:46] } 21... Rfc8 { [%eval -2.33] [%clk 0:16:52] } 22. Kg2 { [%eval -2.4] [%clk 0:27:49] } 22... Bb4 { [%eval -2.39] [%clk 0:15:38] } 23. Re2 { [%eval -2.36] [%clk 0:25:34] } 23... Rc1 { [%eval -2.05] [%clk 0:15:39] } 24. Rxc1 { [%eval -1.96] [%clk 0:24:44] } 24... Rxc1 { [%eval -2.09] [%clk 0:16:07] } 25. Rc2 { [%eval -2.1] [%clk 0:20:02] } 25... Rd1? { [%eval -0.71] } { Mistake. Ra1 was best. } { [%clk 0:13:38] } 26. Ba6?? { [%eval -3.31] } { Blunder. Rc7 was best. } { [%clk 0:19:52] } 26... Bf5 { [%eval -3.26] [%clk 0:13:50] } 27. Rc7 { [%eval -3.19] [%clk 0:17:51] } 27... Be4 { [%eval -3.21] [%clk 0:14:15] } 28. Kf2 { [%eval -3.5] [%clk 0:17:54] } 28... Ra1 { [%eval -3.36] [%clk 0:14:38] } 29. a4 { [%eval -3.5] [%clk 0:17:14] } 29... Ra2+ { [%eval -3.16] [%clk 0:13:33] } 30. Ke3 { [%eval -3.65] [%clk 0:17:25] } 30... Rb2 { [%eval -3.94] [%clk 0:13:49] } 31. Rc8+ { [%eval -4.09] [%clk 0:15:04] } 31... Kf7 { [%eval -3.68] [%clk 0:13:54] } 32. Bc4?! { [%eval -4.65] } { Inaccuracy. Be2 was best. } { [%clk 0:13:35] } 32... Bxf3 { [%eval -4.54] [%clk 0:14:09] } 33. Kxf3 { [%eval -4.7] [%clk 0:13:55] } 33... dxc4 { [%eval -4.74] [%clk 0:14:31] } 34. bxc4 { [%eval -4.58] [%clk 0:14:13] } 34... Bc3 { [%eval -4.34] [%clk 0:10:54] } 35. Rc7+ { [%eval -4.48] [%clk 0:13:21] } 35... Ke6 { [%eval -4.09] [%clk 0:10:12] } 36. d5+ { [%eval -4.32] [%clk 0:13:21] } 36... Kd6 { [%eval -4.31] [%clk 0:10:36] } 37. Rxg7 { [%eval -4.22] [%clk 0:13:23] } 37... Rxh2 { [%eval -4.08] [%clk 0:10:07] } 38. Rxa7 { [%eval -4.1] [%clk 0:13:28] } 38... h5 { [%eval -3.83] [%clk 0:08:19] } 39. Ke4 { [%eval -4.65] [%clk 0:08:19] } 39... h4 { [%eval -4.52] [%clk 0:05:23] } 40. gxh4 { [%eval -4.82] [%clk 0:07:43] } 40... Rxh4+ { [%eval -4.89] [%clk 0:05:47] } 41. Kd3 { [%eval -5.42] [%clk 0:07:45] } 41... Be5 { [%eval -5.18] [%clk 0:05:54] } 42. a5 { [%eval -5.36] [%clk 0:07:30] } 42... Rd4+ { [%eval -5.27] [%clk 0:06:09] } 43. Ke3 { [%eval -5.63] [%clk 0:06:58] } 43... Rxc4 { [%eval -5.33] [%clk 0:06:32] } 44. axb6 { [%eval -5.02] [%clk 0:05:03] } 44... Kxd5 { [%eval -5.21] [%clk 0:06:34] } 45. Re7 { [%eval -6.13] [%clk 0:04:00] } 45... Rc3+ { [%eval -6.59] [%clk 0:06:47] } 46. Kd2 { [%eval -6.3] [%clk 0:04:08] } 46... Rb3 { [%eval -6.28] [%clk 0:07:11] } 47. b7 { [%eval -6.07] [%clk 0:04:22] } 47... Kc6 { [%eval -5.96] [%clk 0:07:32] } 0-1
+
+

pgn_clean_cg-0.0.0rc2/tests/source_with_computer_eval.pgn.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: none
+# SPDX-License-Identifier: CC0-1.0
+

pgn_clean_cg-0.0.0rc2/tests/test_pgnutils.py

@@ -0,0 +1,81 @@
+# SPDX-License-Identifier: MIT
+# SPDX-FileCopyrightText: 2026 Espen Sandøy Hustad <espen@ehustad.com>
+
+from pathlib import Path
+from typing import List
+import unittest
+
+import chess.pgn
+
+from pgn_clean_cg import pgnutils
+
+
+def _get_path(filename: str) -> Path:
+    return Path(__file__).parent.joinpath(filename)
+
+
+class TestPGNUtils(unittest.TestCase):
+
+    def test_remove_comment(self):
+        games = self._load_cleaned_games("source_with_computer_eval.pgn")
+        for game in games:
+            for move in game.mainline():
+                move.set_clock(None)
+                self.assertFalse(move.comment)
+
+    def test_remove_eval(self):
+        games = self._load_cleaned_games("source_with_computer_eval.pgn")
+        for game in games:
+            for move in game.mainline():
+                self.assertTrue(move.eval() is None)
+
+    def test_remove_nags(self):
+        games = self._load_cleaned_games("source_with_computer_eval.pgn")
+        for game in games:
+            for move in game.mainline():
+                self.assertFalse(move.nags)
+
+    def test_remove_variations(self):
+        actual = self._load_cleaned_games("source.pgn")
+        expected = self._load_raw_games("expected.pgn")
+
+        self.assertEqual(len(actual), len(expected))
+
+        for i in range(len(actual)):
+            self.assertEqual(str(actual[i]), str(expected[i]))
+
+    def test_retain_clock(self):
+        games = self._load_cleaned_games("source_with_clk.pgn")
+        for game in games:
+            for move in game.mainline():
+                self.assertTrue(move.clock())
+
+    def _load_raw_games(self, name: str) -> List[chess.pgn.Game]:
+        ret = []
+
+        with _get_path(name).open() as f:
+            while True:
+                game = chess.pgn.read_game(f)
+                if game is None:
+                    break
+                ret.append(game)
+
+        self.assertTrue(ret)
+        return ret
+
+    def _load_cleaned_games(self, name: str) -> List[chess.pgn.Game]:
+        ret = []
+
+        with _get_path(name).open() as f:
+            ret = self.cgcleaner.clean(f)
+
+        self.assertTrue(ret)
+        return ret
+
+    def setUp(self):
+        self.cgcleaner = pgnutils.CGCleaner()
+        self.maxDiff = None
+
+
+if __name__ == "__main__":
+    unittest.main()