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

Uploaded Source

Built Distribution

fairyfishnet-1.16.33-py2.py3-none-any.whl (36.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.33.tar.gz
  • Upload date:
  • Size: 36.4 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.33.tar.gz
Algorithm Hash digest
SHA256 5ed86ab79b17f542cb31883c762760543dd3ea3b7ab044417782d5cf25768a3d
MD5 3503c6866a0eb912ffddca91dc78a3a5
BLAKE2b-256 47e02af57ada1fa113da61ad704ed1dbc56b55c882a23d6e9a93b186c62698c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.33-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5863470c3308b18a8241cce715d754e8262754f08657976581722d5a5526839e
MD5 45bc907fae3bf1f8e5b7585f839e94d4
BLAKE2b-256 de01e8e76cf3c34b3de6a494ad18daf07bfca985578f1f8b053c09aaa72800a0

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