Metadata-Version: 2.1
Name: fishnet
Version: 1.17.2
Summary: Distributed Stockfish analysis for lichess.org
Home-page: https://github.com/niklasf/fishnet
Author: Niklas Fiekas
Author-email: niklas.fiekas@backscattering.de
License: UNKNOWN
Keywords: lichess.org lichess chess stockfish uci
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*
Description-Content-Type: text/x-rst
Requires-Dist: requests (<3,>=2)

fishnet: distributed Stockfish analysis for lichess.org
=======================================================

.. image:: https://badge.fury.io/py/fishnet.svg
    :target: https://pypi.python.org/pypi/fishnet
    :alt: pypi package

.. image:: https://travis-ci.org/niklasf/fishnet.svg?branch=v1.17.2
    :target: https://travis-ci.org/niklasf/fishnet
    :alt: build

Installation
------------

1. Request your personal fishnet key: https://lichess.org/get-fishnet
2. Install the fishnet client.

   **Via pip**

   To install or upgrade to the latest version do:

   ::

       pip install --upgrade --user fishnet

   Example usage:

   ::

       python -m fishnet --auto-update

   Other useful commands:

   ::

       python -m fishnet configure  # Rerun the configuration dialog
       python -m fishnet systemd  # Generate a systemd service file
       python -m fishnet --help  # List all commands and options

   **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

Video tutorial
--------------

.. image:: https://img.youtube.com/vi/iPRNluVn22w/0.jpg
    :target: https://www.youtube.com/watch?v=iPRNluVn22w
    :alt: Introduction video


lichess.org custom Stockfish
----------------------------

fishnet is using
`lichess.org custom Stockfish <https://github.com/niklasf/Stockfish/tree/fishnet>`__
by `@ddugovic, @ianfab et al <https://github.com/ddugovic/Stockfish>`_.

You can build Stockfish yourself (for example with ``./build-stockfish.sh``)
and provide the path using ``python -m fishnet --stockfish-command``. Otherwise
a precompiled binary will be downloaded for you.

Protocol
--------

.. image:: https://raw.githubusercontent.com/niklasf/fishnet/master/doc/sequence-diagram.png

See `protocol.md <https://github.com/niklasf/fishnet/blob/master/doc/protocol.md>`_ for details.

License
-------

fishnet is licensed under the GPLv3+ license. See LICENSE.txt for the full
license text.


