Skip to content

ShneM/fishnet

 
 

Repository files navigation

fishnet: distributed Stockfish analysis for lichess.org

pypi package build

Installation

  1. Request your personal fishnet key: https://lichess.org/get-fishnet

  2. Install the fishnet client.

    Via pip

    To install or upgrade to the latest version do:

    pip install --upgrade --user fishnet
    

    Example usage:

    python -m fishnet --auto-update
    

    Other useful commands:

    python -m fishnet configure  # Rerun the configuration dialog
    python -m fishnet systemd  # Generate a systemd service file
    python -m fishnet --help  # List all commands and options
    

    Via Docker

    There is a Docker container courtesy of @mklemenz. For example you can simply do:

    docker run mklemenz/fishnet --key MY_APIKEY --auto-update
    

Video tutorial

Introduction video

lichess.org custom Stockfish

fishnet is using lichess.org custom Stockfish by @ddugovic, @ianfab et al.

You can build Stockfish yourself (for example with ./build-stockfish.sh) and provide the path using python -m fishnet --stockfish-command. Otherwise a precompiled binary will be downloaded for you.

Protocol

https://raw.githubusercontent.com/niklasf/fishnet/master/doc/sequence-diagram.png

See protocol.md for details.

License

fishnet is licensed under the GPLv3+ license. See LICENSE.txt for the full license text.

About

Distributed Stockfish analysis for lichess.org

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.7%
  • Other 1.3%