Metadata-Version: 2.4
Name: fidereport
Version: 2026.10.17
Summary: Automate creation of FIDE reports
Home-page: https://bitbucket.org/limliga/elo
Download-URL: https://bitbucket.org/limliga/elo/get/master.tar.gz
Author: Dries Moors
Author-email: Dries Moors <dries.moors@limliga.be>
Maintainer: Dries Moors
Maintainer-email: dries.moors@limliga.be
License: MIT
Project-URL: Homepage, https://bitbucket.org/limliga/elo
Project-URL: Documentation, https://bitbucket.org/limliga/elo
Project-URL: Repository, https://bitbucket.org/limliga/elo
Project-URL: Issues, https://bitbucket.org/limliga/elo/issues
Keywords: FIDE,report,chess,elo,rating
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: types-requests>=2.0.0; extra == "dev"
Requires-Dist: types-pyyaml>=6.0.0; extra == "dev"
Dynamic: author
Dynamic: download-url
Dynamic: home-page
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: requires-python

---
title: fidereport
author: Dries Moors
date: 2022-07-16
typora-root-url:./
---

<img src="http://www.limliga.be/images/LogoLimburgRoodGeelGroot.gif"  />

# fidereport

Creates FIDE reports of CSV games.

- Automated download of the FRBE-KBSB-KSB Belgian rating list
- Automated download of the FIDE rating list
- Possible to limit the FIDE report to specific rounds
- Optional settings YAML file (defaults are used if not provided)
- Database files cached in system temporary directory

## Installation

For installation instructions, see [INSTALL.md](INSTALL.md).

## Usage

Example invocation:
```bash
fidereport -g games.csv -r 1-10 -o fide_report.trf -s settings.yaml
```

The fidereport command accepts the following arguments:

```bash
fidereport -g games.csv -r 1,2,3 -o fide_report.txt [-s settings.yaml]
```

**Required arguments:**
- `-g, --games FILE`: Path to CSV file containing game data
- `-r, --rounds ROUNDS`: Comma-separated list of round numbers or ranges (e.g., "1,2,3" or "1-5")
- `-o, --output FILE`: Output file path for the FIDE report

**Optional arguments:**
- `-s, --settings FILE`: Path to YAML settings file with tournament headers. If not provided, default values are used.

### Settings File

Example minimal settings.yaml:
```yaml
---
tournament name: 78ste Limburgse Interclubs 2025-2026
start date: 2025/09/19
end date: 2026/04/24
round dates: 25/09/19 25/10/17 25/11/14 25/11/28 26/01/09 26/01/30 26/03/06 26/03/20 26/04/24
tournament leader: 232602 Bils, Marc  # Chief Arbiter
referees: 239828 Martens, Ludo; 205494 Cornet, Luc  # Deputy Chief Arbiter
---
```

**Default values are used for:** type, country, teams count, tournament structure, time schedule.

**Automatically determined (need not be provided):**
- players count
- fide players count
- played rounds

**Examples:**
```bash
# Process rounds 1 through 5 with default settings
fidereport -g tournament_games.csv -r 1-5 -o fide_output.txt

# Process specific rounds with custom settings file
fidereport -g games.csv -r 1,3,5 -o report.txt -s my_settings.yaml

# Get help
fidereport --help
```

Or using Python module syntax:

```bash
python3 -m fidereport -g games.csv -r 1-5 -o fide_report.txt
python3 -m fidereport --help
```
