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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.40.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.40.tar.gz
Algorithm Hash digest
SHA256 7d946a3bd2509f5215e5bf68fc5406fd25c3367713ea3dee47cefc75d4ceda5f
MD5 d7c7686e19f2dedaee3b30f4050add32
BLAKE2b-256 d289240c3a244abe340070822a9d5d006d625b6cf3b137aee91ca920fa367f7d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.40-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bcf6a89535733bd6bbd1ac38bec92b77c82976ce18e14e5d0043d717c77d2961
MD5 e0992af82b4d136925d3d0e672182c82
BLAKE2b-256 09c4d48784f7ce8e0420c6c2afdef247d03a461d6acc0b4128f5476d86205510

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