summaryrefslogtreecommitdiff
path: root/README.md
blob: 6152300df5cd54ff62fa7d32360db25835bd2bfb (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
# teamy-quick-lineup
Command-line interface for line-up management in JFR Teamy.

# Installation

Prerequisites:

* Python 3 (on Windows <= 3.4 due to the availability of MySQL connector)
* pip
* Windows environment: MySQL connector from Oracle, unavailable via PIP - https://dev.mysql.com/downloads/connector/python/

```
pip install -r requirements-PLATFORM.txt
```

Where `PLATFORM` is either `windows` or `linux`.

# Configuration

Set MySQL settings in ql/settings.py.

For Linux, you can leave the default `engine` property, for Windows, you have to change it to `mysql.connector.django` to use Oracle connector.

# Usage

```
python quick_lineup.py <round> <segment> [<start from table>]
```

For instance, to process round 3, segment 2, starting from table 1 run:

```
python quick_lineup.py 3 2 1
```

The script will iterate pair by pair in each match. It presents the currently assigned players and let you confirm them - pressing ENTER without any input - or change - providing player names (press TAB to autocomplete).

# Build process

See: [BUILD.md](BUILD.md)