Skip to main content

Create a graphical table of contents for chess games with engine analysis

Project description

python-chess-toc

Create a graphical table of contents for chess games with engine analysis

The chesstoc package takes a PGN file and generates an HTML file with a graphical table of contents for the PGN file. Each table entry is a board with the final position for a game, superimposed with the plot of the engine evaluation function.

For example,

python3 -m chesstoc --time 1.0 --html candidates.html candidates.pgn --col 2

analyzes the games from candidates.pgn, spending one second per move, and produces an HTML file with a two-column table that looks like this:

TOC for candidates.pgn

Installation

pip install python-chess-toc

Dependencies

  • python 3
  • python-chess
  • jinja2
  • matplotlib
  • svgutils
  • a UCI chess engine (only tested with Stockfish)

Acknowledgements

Many thanks to the authors of all the packages above. The present package is merely a thin layer of glue that gets python-chess to do the parsing, talking to the engine, and board rendering, and then feeds the numbers into matplotlib and svgutils to produce the figures, and finally uses jinja2 to generate the HTML. Also, I borrowed the opening database from https://github.com/niklasf/eco and borrowed some ideas from https://github.com/rpdelaney/python-chess-annotator.

License

python-chess-toc is licensed under the GPL 3 (or any later version at your option). Check out LICENSE.txt for the full text.

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

python-chess-toc-0.1.1.tar.gz (102.4 kB view details)

Uploaded Source

Built Distribution

python_chess_toc-0.1.1-py3-none-any.whl (118.5 kB view details)

Uploaded Python 3

File details

Details for the file python-chess-toc-0.1.1.tar.gz.

File metadata

  • Download URL: python-chess-toc-0.1.1.tar.gz
  • Upload date:
  • Size: 102.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for python-chess-toc-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c302be3dbdf178775c00f9800e707a684d5331539aea579ebfa8a966e8eaf50c
MD5 15b1307b2175033ac033b64f267bd050
BLAKE2b-256 ba4463b93d5c13b8152d6e648b1036f67d0acff5ba22187bc59f1ddea9a01e7a

See more details on using hashes here.

File details

Details for the file python_chess_toc-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: python_chess_toc-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 118.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for python_chess_toc-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8150b2b9903d9b1da97fe0caef919a89b915f97ece3c172c2b8f6132e25bb327
MD5 9563c8c3ed0d4c97586c6003648f2bad
BLAKE2b-256 e6ded0a274a1dcf89ef316f9042fc642c3913e404a5e87fded9a1feb5be73e48

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