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/56/f9/edff8efb69950445963704de901acb759760df8cf86505fad701c4467d6d/fairyfishnet-1.16.39.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\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Distributed Fairy-Stockfish analysis for pychess-variants",
"version": "1.16.39",
"project_urls": {
"Homepage": "https://github.com/gbtami/fairyfishnet"
},
"split_keywords": [
"lichess.org",
"chess",
"stockfish",
"uci"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "639fff88b1b1cdffa51f7af4b6bd7cc7cc3acac4a734693d0f3920ae2537c334",
"md5": "0da4c3db81ddf9ea9000ff86b9d83011",
"sha256": "9f93d397b669579a244157519b732aba76e1f8f78631824ed6e2b14fb1a92895"
},
"downloads": -1,
"filename": "fairyfishnet-1.16.39-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0da4c3db81ddf9ea9000ff86b9d83011",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 36036,
"upload_time": "2024-03-24T19:08:45",
"upload_time_iso_8601": "2024-03-24T19:08:45.876061Z",
"url": "https://files.pythonhosted.org/packages/63/9f/ff88b1b1cdffa51f7af4b6bd7cc7cc3acac4a734693d0f3920ae2537c334/fairyfishnet-1.16.39-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56f9edff8efb69950445963704de901acb759760df8cf86505fad701c4467d6d",
"md5": "4d50df213f337f4a7decafdfa2a263a2",
"sha256": "ce26a0cfa3738c8480df9cf7c204e9faff99c7591a5643ddc99c773a0f275265"
},
"downloads": -1,
"filename": "fairyfishnet-1.16.39.tar.gz",
"has_sig": false,
"md5_digest": "4d50df213f337f4a7decafdfa2a263a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 36482,
"upload_time": "2024-03-24T19:08:48",
"upload_time_iso_8601": "2024-03-24T19:08:48.363686Z",
"url": "https://files.pythonhosted.org/packages/56/f9/edff8efb69950445963704de901acb759760df8cf86505fad701c4467d6d/fairyfishnet-1.16.39.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-24 19:08:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gbtami",
"github_project": "fairyfishnet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "pyffish",
"specs": [
[
"==",
"0.0.81"
]
]
},
{
"name": "gdown",
"specs": [
[
"==",
"5.1.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.2"
]
]
}
],
"lcname": "fairyfishnet"
}
JSON
