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

Uploaded Source

Built Distribution

fairyfishnet-1.16.42-py2.py3-none-any.whl (36.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.42.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for fairyfishnet-1.16.42.tar.gz
Algorithm Hash digest
SHA256 1e4ff163f69486d6b514dbdfd1c937cbd6ac0b78aa1801581166c760e9e2c0a1
MD5 e7347ac1ca365ca724057d5fc392b4dd
BLAKE2b-256 788b83942dde8e349860281938e3ccda4c39a4e4fedd3ba4817ead29b2f44850

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.42-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1d89a3b3140398c3f4054542aa8f07567098a68b9f3a590b63177a90595276d2
MD5 00f05eca44e04adcdb680f8e6c2c34af
BLAKE2b-256 707427704d2e48efa5f3b35a542fe0f710a5852abb4d642ae19eb02a6426c35e

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