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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.29.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.29.tar.gz
Algorithm Hash digest
SHA256 1a2fab3c90635c8d82fe109657af15383c8602016afbdd67fb8ded51a6ed886f
MD5 9586c3dcfa3bf3a040dd73ca1ae6b00c
BLAKE2b-256 8e7a49320cb162b57899f1b05dd9aebfb9b4767951d8086ad3b8d2f44910d61b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.29-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4b5872e4b49a04574f3801c9ae937742877cbecf50988769159262f2b566e9ea
MD5 c90246415d8b74b9ff4dd92cd49548da
BLAKE2b-256 6a2908a1e87a57bf412faf2904204a10380bbe993fdd4d8dff79d11557c393a7

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