Skip to main content

Distributed Fairy-Stockfish analysis for pychess-variants

Project description

https://badge.fury.io/py/fairyfishnet.svg

Installation

  1. Request your personal fairyfishnet key on pychess Discord https://discord.gg/aPs8RKr

  2. Install the fairyfishnet client.

    Via pip

    To install or upgrade to the latest version do:

    pip3 install --upgrade --user fairyfishnet

    Example usage:

    python3 -m fairyfishnet --auto-update

    Optional: Generate a systemd service file:

    python3 -m fairyfishnet systemd

    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

pychess-variants custom Fairy-Stockfish

fairyfishnet is using Fairy-Stockfish by @ianfab.

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

Overview

https://raw.githubusercontent.com/gbtami/fairyfishnet/master/doc/sequence-diagram.png

See protocol.md for details.

License

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fairyfishnet-1.16.26.tar.gz (35.0 kB view details)

Uploaded Source

Built Distribution

fairyfishnet-1.16.26-py2.py3-none-any.whl (34.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fairyfishnet-1.16.26.tar.gz.

File metadata

  • Download URL: fairyfishnet-1.16.26.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.11

File hashes

Hashes for fairyfishnet-1.16.26.tar.gz
Algorithm Hash digest
SHA256 84a318ac4309904e1db89fce32520a2742f53c1e1da73e886f7e36f0bfe9f8fc
MD5 a36cb21da6c0f0d452ebbda1643d40d4
BLAKE2b-256 9adf225c841c305c2591d932f454e9728ca8ccbf25a9e00c4b4fbf691b5a651e

See more details on using hashes here.

File details

Details for the file fairyfishnet-1.16.26-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fairyfishnet-1.16.26-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bab9d235cb78e0a5bfa46d373e1c109d1dd370c67ee5afe8dd91689f570d9fff
MD5 f415886fbe45c7b5dd49d2986bba2093
BLAKE2b-256 af27c4a13b320e263cc344fa3939fa4526589dde2321d1fe514e8aa14f4df84b

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