Metadata-Version: 2.4
Name: ooresults
Version: 0.4.8
Summary: A software for the evaluation of the results of orienteering events
Author: Rainer Garus
License-Expression: AGPL-3.0-or-later
Project-URL: Repository, https://github.com/rgarus/ooresults
Project-URL: Documentation, https://ooresults.readthedocs.io/en/latest
Project-URL: Changelog, https://github.com/rgarus/ooresults/blob/main/CHANGELOG.rst
Keywords: orienteering,sportident
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: bottle==0.13.4
Requires-Dist: case-converter
Requires-Dist: cheroot>=11.1.2
Requires-Dist: clevercsv
Requires-Dist: fastclasses-json
Requires-Dist: fpdf2==2.6.1
Requires-Dist: iso8601
Requires-Dist: jsonschema
Requires-Dist: lxml
Requires-Dist: Mako==1.3.11
Requires-Dist: pyOpenSSL
Requires-Dist: pyserial
Requires-Dist: requests[use_chardet_on_py3]
Requires-Dist: sireader
Requires-Dist: tzlocal
Requires-Dist: unidecode
Requires-Dist: websocket-client
Requires-Dist: websockets>=14.2
Provides-Extra: test
Requires-Dist: pytest>=8.3.3; extra == "test"
Requires-Dist: pytest-asyncio>=0.24.0; extra == "test"
Requires-Dist: selenium>=4.26.1; extra == "test"
Dynamic: license-file

.. image:: https://img.shields.io/pypi/v/ooresults
    :target: https://pypi.org/project/ooresults/

.. image:: https://img.shields.io/pypi/pyversions/ooresults
    :target: https://pypi.org/project/ooresults/

.. image:: https://img.shields.io/pypi/l/ooresults
    :target: https://pypi.org/project/ooresults/

.. image:: https://readthedocs.org/projects/ooresults/badge/?version=latest
    :target: https://ooresults.readthedocs.io/en/latest/?badge=latest


ooresults
---------

ooresults (open orienteering results) is a software to compute the results of orienteering events.
Here, "open" stands for "Open Source" (licensed under AGPL) on the one hand,
and for "Open Architecture" (extendable by plugins) on the other.
ooresults is able to read SPORTident cards.

ooresults uses Python 3.10+ and is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3.
It consists of two programs:

- **ooresults-server**

   ooresults-server is a web server for managing and storing data. It uses TCP ports 8080 and 8081.

- **ooresults-reader**

   ooresults-reader reads the data of a SI-Card with the help of a connected SPORTident readout station
   and sends the data to the ooresults-server.

The operation takes place by means of a current web browser (Chrome, Firefox, Edge, ...).

ooresults was successfully used to compute the results of the SILVA O-Night 2023 in Munich.


Features
--------

- Multi-user capable
- Reading SPORTident cards
- Installation only necessary on the server and computers with connected SPORTident readout station,
  other computers only need a current web browser
- Supports visiting controls in specific order or in no specific order
- Supports score competitions
- Calculation of a total result of several events possible
- Transfer of competitor lists of an event from OrienteeringOnline.net via OE2003-CSV export
- Import of competitor lists of an event in IOF 3.0 XML format
- Import of course data in IOF 3.0 XML format (e.g. PurplePen)
- Export of results in IOF 3.0 XML format
- Creation of result lists as PDF files


Documentation
-------------

Users of the ooresults software should read the `user documentation <https://ooresults.readthedocs.io/en/latest/>`_ (currently only available in German).
It contains the installation, a tutorial, a reference guide and the configuration.

Developers of ooresults should also read the `developer documentation <https://ooresults-dev.readthedocs.io/en/latest/>`_.
