Metadata-Version: 2.4
Name: bingotool
Version: 1.1.2
Summary: Script to call out bingo numbers
Author-email: hellfire103 <edanosborne@duck.com>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-Expression: Beerware
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
License-File: LICENSE
Requires-Dist: charset_normalizer
Requires-Dist: pyfiglet
Project-URL: Homepage, https://codeberg.org/hellfire103/bingotool
Project-URL: Issues, https://codeberg.org/hellfire103/bingotool/issues

# bingotool

A customisable script to display bingo numbers.

## Usage

```
usage: bingotool.py [-h] [-v] [-n NAMES] [minimum] [maximum]

generate bingo numbers

positional arguments:
  minimum            lowest bingo number (default: 1)
  maximum            highest bingo number (default: 90)

options:
  -h, --help        show this help message and exit
  -v, --version     display software version
  -n, --names FILE  display bingo names from FILE
```

## Customisation

You can specify your own bingo lingo in the form of a JSON file by passing the `-n` or `--names` argument. An example file containing the standard names is included in this repo.

## Installation

### Using `pip`

```Bash
pip install --upgrade bingotool
```

### Using `pipx`

```Bash
pipx install bingotool
```

### Manual

1. Clone the repo:
   ```
   git clone https://codeberg.org/hellfire103/bingotool
   ```
   **or**
   ```
   git clone https://source.community/hellfire103/bingotool.git
   ```
2. Install the following modules as system packages (i.e. using `apt`, `pacman`, etc.):
   * python3
   * python3-pyfiglet
3. Install [charset_normalizer](https://github.com/jawah/charset_normalizer)
4. Install the script:
   ```
   sudo install -m 755 bingotool.py /usr/local/bin/bingotool
   ```
5. *(Optional)* Install the manpage:
   ```
   gzip -c bingotool.1 | sudo tee /usr/local/share/man/man1/bingotool.1.gz
   ```

