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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: fairyfishnet-1.16.34.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.34.tar.gz
Algorithm Hash digest
SHA256 17c8c2253b3d7d155275ee87c249fa9ecdb99b939560a152547c1efa07a46a65
MD5 4a26eb1e5633576b40dd9739ec4d3e3e
BLAKE2b-256 d6b098fb1f0e72e5ccc68607bd1fe713d34f3e838e4ccebb441de47c03174644

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fairyfishnet-1.16.34-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 178782e9bb03894b9780836649f633c21a5b62548d77f3f1f564abea12f96ea3
MD5 37b2044c3abbf623fcfd284a96df6b12
BLAKE2b-256 7c92ca1cdbb38c7fddd9e20e9e488585b68d0c2e12af5c5c3639ba6279126f58

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