fairyfishnet: distributed Fairy-Stockfish analysis for pychess.org
==================================================================
.. image:: https://badge.fury.io/py/fairyfishnet.svg
:target: https://pypi.python.org/pypi/fairyfishnet
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 <https://hub.docker.com/r/mklemenz/fishnet/>`_
courtesy of `@mklemenz <https://github.com/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 <https://github.com/ianfab/Fairy-Stockfish>`__
by `@ianfab <https://github.com/ianfab/Fairy-Stockfish>`_.
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
--------
.. image:: https://raw.githubusercontent.com/gbtami/fairyfishnet/master/doc/sequence-diagram.png
See `protocol.md <https://github.com/gbtami/fairyfishnet/blob/master/doc/protocol.md>`_ for details.
License
-------
fairyfishnet is licensed under the GPLv3+ license. See LICENSE.txt for the full
license text.
Raw data
{
"_id": null,
"home_page": "https://github.com/gbtami/fairyfishnet",
"name": "fairyfishnet",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "lichess.org chess stockfish uci",
"author": "Bajusz Tam\u00e1s",
"author_email": "gbtami@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/8b/83942dde8e349860281938e3ccda4c39a4e4fedd3ba4817ead29b2f44850/fairyfishnet-1.16.42.tar.gz",
"platform": null,
"description": "fairyfishnet: distributed Fairy-Stockfish analysis for pychess.org\n==================================================================\n\n.. image:: https://badge.fury.io/py/fairyfishnet.svg\n :target: https://pypi.python.org/pypi/fairyfishnet\n\nInstallation\n------------\n\n1. Request your personal fairyfishnet key on pychess Discord https://discord.gg/aPs8RKr\n2. Install the fairyfishnet client.\n\n **Via pip**\n\n To install or upgrade to the latest version do:\n\n ::\n\n pip3 install --upgrade --user fairyfishnet\n\n Example usage:\n\n ::\n\n python3 -m fairyfishnet --auto-update\n\n Optional: Generate a systemd service file:\n\n ::\n\n python3 -m fairyfishnet systemd\n\n **Via Docker**\n\n There is a `Docker container <https://hub.docker.com/r/mklemenz/fishnet/>`_\n courtesy of `@mklemenz <https://github.com/mklemenz>`_. For example you can\n simply do:\n\n ::\n\n docker run mklemenz/fishnet --key MY_APIKEY --auto-update\n\npychess-variants custom Fairy-Stockfish\n---------------------------------------\n\nfairyfishnet is using\n`Fairy-Stockfish <https://github.com/ianfab/Fairy-Stockfish>`__\nby `@ianfab <https://github.com/ianfab/Fairy-Stockfish>`_.\n\nYou can build Fairy-Stockfish yourself (for example with ``./build-stockfish.sh``)\nand provide the path using ``python -m fairyfishnet --stockfish-command``. Otherwise\na precompiled binary will be downloaded for you.\n\nOverview\n--------\n\n.. image:: https://raw.githubusercontent.com/gbtami/fairyfishnet/master/doc/sequence-diagram.png\n\nSee `protocol.md <https://github.com/gbtami/fairyfishnet/blob/master/doc/protocol.md>`_ for details.\n\nLicense\n-------\n\nfairyfishnet is licensed under the GPLv3+ license. See LICENSE.txt for the full\nlicense text.\n",
"bugtrack_url": null,
"license": null,
"summary": "Distributed Fairy-Stockfish analysis for pychess-variants",
"version": "1.16.42",
"project_urls": {
"Homepage": "https://github.com/gbtami/fairyfishnet"
},
"split_keywords": [
"lichess.org",
"chess",
"stockfish",
"uci"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "707427704d2e48efa5f3b35a542fe0f710a5852abb4d642ae19eb02a6426c35e",
"md5": "00f05eca44e04adcdb680f8e6c2c34af",
"sha256": "1d89a3b3140398c3f4054542aa8f07567098a68b9f3a590b63177a90595276d2"
},
"downloads": -1,
"filename": "fairyfishnet-1.16.42-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "00f05eca44e04adcdb680f8e6c2c34af",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 36108,
"upload_time": "2024-10-30T09:17:56",
"upload_time_iso_8601": "2024-10-30T09:17:56.448642Z",
"url": "https://files.pythonhosted.org/packages/70/74/27704d2e48efa5f3b35a542fe0f710a5852abb4d642ae19eb02a6426c35e/fairyfishnet-1.16.42-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "788b83942dde8e349860281938e3ccda4c39a4e4fedd3ba4817ead29b2f44850",
"md5": "e7347ac1ca365ca724057d5fc392b4dd",
"sha256": "1e4ff163f69486d6b514dbdfd1c937cbd6ac0b78aa1801581166c760e9e2c0a1"
},
"downloads": -1,
"filename": "fairyfishnet-1.16.42.tar.gz",
"has_sig": false,
"md5_digest": "e7347ac1ca365ca724057d5fc392b4dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 36483,
"upload_time": "2024-10-30T09:17:57",
"upload_time_iso_8601": "2024-10-30T09:17:57.906984Z",
"url": "https://files.pythonhosted.org/packages/78/8b/83942dde8e349860281938e3ccda4c39a4e4fedd3ba4817ead29b2f44850/fairyfishnet-1.16.42.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 09:17:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gbtami",
"github_project": "fairyfishnet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "fairyfishnet"
}
JSON
