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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.41.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.41.tar.gz
Algorithm Hash digest
SHA256 2d81b01f1bd0232576e595f2f40e16cd38274256b94e7926f784ab179b7aa312
MD5 cb198f5549c00a63430bcc92ee3fb4b9
BLAKE2b-256 bc4732a4a07a18c9a285a285a0fcdee48623ed55ece852d88a44f54d31df6f33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.41-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 86f5843a5979940d8c998f63cf992e5f696311d106261f2e6d18ee5ba6b6bac0
MD5 ca093d2815d6eb587bd3b4ee2b622ae6
BLAKE2b-256 0fe221ad63bf69cb4496a019e5a4695fde6ee7208dbcbeb7d5865184a7ef86cc

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