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.22.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

fairyfishnet-1.16.22-py2.py3-none-any.whl (34.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for fairyfishnet-1.16.22.tar.gz
Algorithm Hash digest
SHA256 0f1844ceaf0267b63bce88ab5473e7fc4795472aacbfdab78db9f0d404ead1e1
MD5 af7d0a8a77b1264faf4108cf7dd38371
BLAKE2b-256 bb6f1f3ff3ec91872b80a639d309cc19606c09e06aafe97fef0c33dc07c043bf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.22-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2718cbfc7859c2b016e126d1b2d7bbdd9d64fb9a54cb2a79ae08980e4db6d964
MD5 f63952b17172ccd1824209ded7910fad
BLAKE2b-256 fb54672d27b27d6d6541ccdb0f5b978fbcdee63caa6491cb58dae333283dadf1

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