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

Uploaded Source

Built Distribution

fairyfishnet-1.16.28-py2.py3-none-any.whl (35.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.28.tar.gz
  • Upload date:
  • Size: 35.8 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.28.tar.gz
Algorithm Hash digest
SHA256 61e839a466e5e62c114d60809062f130afdf670e2053c1ba118e0b92810c92c2
MD5 aece5e694339779c62bf913e9507f314
BLAKE2b-256 45af258a729ef617426897e15c446a4638c60fecc6674d8654758666354237ce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.28-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7809bf3190a2db25c03feb2cc422115b5b3c19c06c2950b2f595503c44207d4d
MD5 f4ba405360682bebb2d5a78d294a1026
BLAKE2b-256 3816b6112d985e92fb6f277a838ad243257c020fe4ace60d1cebeeb437af2021

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