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
|
`membernator` is a tool that can be used to scan membership cards and establish if
they're valid or not against a CSV database.
# Dependencies
This program is written in Python 3. You will need to install these dependencies
to run `membernator` properly:
* python3
* pygame
* docopt
# Installation
## Debian
`membernator` is packaged in Debian! You can install it using:
$ sudo apt install membernator
## With setup.py
You can install `membernator` like any other python program with the help of
`setuptools`:
$ python3 setup.py install
## With pip
You can install `membernator` by downloading it from PyPi:
$ pip3 install membernator
# Internationalisation
Membernator supports internationalisation. If you wish to add new locales, you
can use the files in the `locales` directory.
Current locales supported are:
* English (default)
* French
Note that internationalisation is only supported if you install the Debian
package.
# Usage
Usage:
membernator [options] --database FILE
membernator (-h | --help)
membernator --version
Options:
-h --help Shows the help screen
--version Outputs version information
--database FILE Path to the CSV database
--id_col ID "id" column in the CSV database. [default: ID]
--name_col NAME "name" column in the CSV database. [default: NAME]
--time SEC Delay in secs between scans. [default: 2.5]
--width WIDTH Width in pixels. Use 0 for fullscreen. [default: 800]
--height HEIGHT Height in pixels. Use 0 for fullscreen. [default: 480]
--logfile LOG Path to the logfile
|
