Welcome to chess_gif’s documentation!

chess_gif is a python library for easily making GIFs of chess games in PGN (Portable Game Notation) format which is the standard plain text format for recording chess games.

chess_gif provides allows users to create highly customizable and optimized GIFs from the PGN files of your chess games.

Installation

You can install chess_gif from PyPI.

pip install chess_gif

chess_gif requires pyvips and pygifsicle as its dependencies:

  1. Windows users need to download the pyvip’s binaries and add vips-dev-x.y\bin to their PATH variable for its installation. You can download the binaries by clicking here. Linux and macOS users need not worry about this and can simply skip this step. For further details, refer pyvip’s installation guide.

  2. While running the installation, on MacOS the setup will automatically install gifsicle using Brew.

    On Linux you will need to install gifsicle using apt-get as follows:

    sudo apt-get install gifsicle

    On Windows you will need to download and install the appropriate port of the library for your OS. Add the path to gifsicle.exe file to your PATH variable.

Contents:

Indices and tables