Metadata-Version: 2.1
Name: uci-net
Version: 1.2.7
Summary: Universal Chess Interface client-server conversation.
Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
License: Licence for pydbitkit package
        Copyright (c) 2014, Roger Marsh
        All rights reserved.        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:                
        Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.        
        Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.        
        Neither the name of the owner nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.                
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.        
Project-URL: Homepage, http://www.solentware.co.uk
Project-URL: Repository, https://github.com/RogerMarsh/uci-net.git
Project-URL: Bug Tracker, https://github.com/RogerMarsh/uci-net/issues
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
License-File: LICENCE

===============================
Universal Chess Interface (UCI)
===============================

.. contents::


Description
===========

This package provides a pure Python client-server `Universal Chess Interface`_ to a chess engine intended for analysing positions rather than playing games.


Installation Instructions
=========================

This package is available on PyPI so can be installed by typing

   python -m pip install --user uci-net

at the command prompt.

See `Python`_ and `pip`_ documentation for alternatives and platform-specific points.


Run
===

The command to run the server is:

   python -m uci_net.tcp_driver [port] [allowed callers] path [options]

A path to a UCI chess engine must be given.

See chess engine documentation for options.

By default anyone is allowed to use the server, subject to firewall restrictions.  A comma separated list of hostnames in <allowed callers> prevents hosts not in the list from using the server.

Conections to the server are made on port 'port'.  The default is 11111.

Assuming a hostname 'stockfishbox' with IP address 192.168.0.1 and the default port, suitable engine definition records in `ChessTab`_ are:

   '//stockfishbox:11111?name=Stockfish 12' or
   '//192.168.0.1:11111?name=Stockfish 12'.

The record says 'name=Stockfish 12' because 'Stockfish 12' is the 'id name' value returned by Stockfish 12 in response to the 'uci' command.

The client is run by applications such as `ChessTab`_ when required.


Notes
=====

Project name and package name changed from 'uci' to 'uci-net' prior to upload to PyPI.

The version numbers of uci-net continue on from uci.


.. _Python: https://python.org
.. _pip: https://packaging.python.org/installing
.. _Universal Chess Interface: https://en.wikipedia.org/wiki/Universal_Chess_Interface
.. _ChessTab: http://www.solentware.co.uk/download.html
