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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for fairyfishnet-1.16.20.tar.gz
Algorithm Hash digest
SHA256 d515b8baf012fe89e1356c6ab7a72143caa73f95d1c8328380966cedc924b3ac
MD5 a0fd1d7afd3864ed2b5ea1d21a7b4341
BLAKE2b-256 60e9523439eff61c1feccf502603a471e2dfba375e7f356aa465a12388bcae70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.20-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5e483db55d5c2f9911942f873db5e66633a0fd8fcb590c7836eb0e01c8736fec
MD5 47ebe498d0e6171658371fa6c8c3c7f1
BLAKE2b-256 c9f79d3e40e0be488bbfd692accab1bfcfd6c35ce6cb1ccfd2b747d7b7913be6

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