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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.37.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.37.tar.gz
Algorithm Hash digest
SHA256 b8c63257f143bb149bf81116960cf627ec068e800f524ea2cb3089dcfc5d595c
MD5 eac2cbb58e61c6a143a5d533ec2ddd4a
BLAKE2b-256 507a36efaf0e18ebbf48c81e7d3463f9e95ef48e79c99b6bc20c8b8cde941420

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.37-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1b11eee1e21a09d948f99ff271601f6c29468b3f6fc4f8220535db8a71c70805
MD5 669c71c53e34e4d2ba00e51824481b7a
BLAKE2b-256 838db355b71bf9b0a61035f8292be0f43201327544998f9182f2eeff7c1fbf1c

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