Metadata-Version: 2.4
Name: chessvalidate
Version: 2.0.6
Summary: Validate source documents reporting chess game results.
Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
License-Expression: BSD-3-Clause
Project-URL: Homepage, http://www.solentware.co.uk
Project-URL: Repository, https://github.com/RogerMarsh/chessvalidate.git
Project-URL: Bug Tracker, https://github.com/RogerMarsh/chessvalidate/issues
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
License-File: LICENCE
Requires-Dist: ecfformat==1.0.7
Requires-Dist: emailextract==0.7.14
Requires-Dist: emailstore==1.5.8
Requires-Dist: solentware-misc==1.7.2
Dynamic: license-file

==================================
Results validation for chess games
==================================

.. contents::


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

Prepare validation reports on results of chess games from events such as tournaments and leagues.

Results can be typed in; or extracted from emails or their text, csv, pdf, odt, docx, or spreadsheet attachments.

League fixture lists are used to point out missing or surplus match reports.  Duplicate consistent match reports are treated as a single match report. 


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

This package is not available on PyPI, or any other package index, but can be installed by typing

   python -m pip install --user --trusted-host solentware.co.uk --find-links http://solentware.co.uk/wheels.html chessvalidate

at the command prompt.

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

Then run 'python -m pip check' to identify other packages which need to be installed.

The following should be installed to support extraction of results from pdf and spreadsheet attachments.

* `Xpdf`_, specifically the `pdftotext`_ utility to handle pdf.
* `Gnumeric`_, specifically the ssconvert utility in the `download`_ to handle spreadsheets.

Sometimes it is possible to use `pdfminer3k`_ instead of pdftotext; and `xlsx2csv`_ instead of ssconvert.

Open Document Format (ods) and Office Open XML (xlsx) attachments can be handled without Gnumeric or xlsx2csv.

Open Document Format (odt) and Open Office XML (docx) attachments can be handled without an 'office' application such as Microsoft Office.


Run
===

The command to run this package is:

   python -m chessvalidate.validate

You may need to give the path and version of Python depending on your system's configuration:

   <path to python>/python<version> -m chessvalidate.validate

   For example

      C:\\Python34\\python -m chessvalidate.validate

         on Microsoft Windows or

      python3.4 -m chessvalidate.validate

         on Unix-like systems.

Or use the facilities of your desktop (Microsoft Windows, GNOME, KDE, ...) to set up a convenient way of starting results_report.


Restrictions
============

At time of writing, March 2022, `Gnumeric`_ do not provide installers for Microsoft Windows.  According to the website, provision ceased in August 2014.


Notes
=====

The chessvalidate package supports the collection and validation of game results by event.  It provides data collection for the chesstabular, chessresults and chesssubmit packages.

It is difficult to stray far from the style:

28 January 2015 J Smith 1 0 P Jones

when typing results one per line, or row in csv and spreadsheets, with

J Smith 1 P Jones 0 28 January 2015

and similar not straying too far.  Otherwise you may have to figure some regular expressions to put in the configuration file for the event: avoid having to do this if at all possible.

If the csv or spreadsheet file splits the components of a result into columns you will have to say how to stitch the columns together in the configuration file.


.. _Python: https://python.org
.. _pip: https://packaging.python.org/installing
.. _Xpdf: http://foolabs.com/xpdf/home.html
.. _pdftotext: http://foolabs.com/xpdf/download.html
.. _Gnumeric: http://gnumeric.org
.. _download: http://gnumeric.org/download.html
.. _pdfminer3k: https://pypi.org/project/pdfminer3k
.. _xlsx2csv: https://pypi.org/project/xlsx2csv
