summaryrefslogtreecommitdiff
path: root/README.md
blob: 9ef6dfd4d8e6b0c4caf8f54676a49fe9b262b8d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

JFR Pary - wirtualne stoliki
============================

Narzędzie sprzątające strony wyników z JFR Pary z danych dodanych celem
porównania uczestników z wirtualnym stołem.

Ukrywane są:
* wyniki par ze stolików wirtualnych, również ze zbiorówek oraz pełnych wyników
* linki w liście historii par
* zapisy w protokołach

Pierwszy z wirtualnych zapisów jest pozostawiany na dole protokołu, opatrzony
nagłówkiem.

Przykładowe efekty działania:
[rozdania szkoleniowe z BOOM 2015](http://www.pzbs.pl/wyniki/boom/2015/boom_wirtualne_me.html),
[Kadra U-20 z butlerem ligowym](http://emkael.info/brydz/wyniki/2015/u20_szczyrk/ligowe.html).

Wymagania systemowe
-------------------

* system operacyjny MS Windows (testowane na Win7 i Win8.1)

LUB

* python 2.x (testowane i tworzone w wersji 2.7.10)
* BeautifulSoup4
* lxml (jako parser dla BS4)
* argparse

Kompilacja i praca z kodem narzędzia
------------------------------------

Patrz: [`BUILD.md`](BUILD.md)

Instalacja
----------

Ściągnij plik wykonywalny ze [strony autora](//emkael.github.io/_files/pary-virtual-table/virtual_table.exe).

Już, gotowe.

Na nie-Windowsach wystarczy w analogiczny sposób ściągnąć skrypt źródłowy
Python: [`virtual_table.py`](src/virtual_table.py).

Użycie
------

```
virtual_table.exe [-t OPIS_STOLIKA] PLIK_TURNIEJU.html [NR_PARY NR_PARY ...]
```

Parametry wejściowe:
* ścieżka do pliku PREFIKS.html strony generowanej przez JFR Pary

Opcjonalne parametry:
* `-t OPIS_STOLIKA` lub `--text OPIS_STOLIKA` pozwala ustawić własny nagłówek
stolika w protokołach, zamiast domyślnego "Wirtualny stolik"
* `NR_PARY ...` pozwala samodzielnie określić numery par na wirtualnych stolikach

W przypadku nieokreślenia numerów par, jako pary na stolikach wirtualnych
traktowane są wszystkie pary, których imiona i nazwiska są puste (wg nagłówków
plików historii par).

Parametry odpowiedzialne za logowanie działania programu:
* `-q` lub `--quiet` wyłącza wyświetlanie ostrzeżeń na standardowym wyjściu
błędów
* `-v` lub `--verbose` włącza wyświetlanie dodatkowych informacji na standadowym
wyjściu błędów
* `-l POZIOM` lub `--log-level POZIOM` ustawia poziom logowania zdarzeń do pliku
(DEBUG, INFO, WARNING, ERROR, CRITICAL; domyślnie: INFO)
* `-f PLIK_LOG` lub `--log-file PLIK_LOG` ustawia ścieżkę do pliku dziennika


Lista przyszłych usprawnień
---------------------------

Patrz: [`TODO.md`](TODO.md)

Autor
-----

Michał Klichowicz (mkl)

Licencja
--------

Patrz: [`LICENSE.md`](LICENSE.md)