https://github.com/fritzrehde/footy
A small command line tool to get the latest football scores, fixtures and standings
https://github.com/fritzrehde/footy
bash command-line-tool football shell soccer
Last synced: about 1 year ago
JSON representation
A small command line tool to get the latest football scores, fixtures and standings
- Host: GitHub
- URL: https://github.com/fritzrehde/footy
- Owner: fritzrehde
- License: mit
- Created: 2021-09-27T08:00:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T20:11:43.000Z (over 3 years ago)
- Last Synced: 2023-03-09T23:26:01.742Z (over 3 years ago)
- Topics: bash, command-line-tool, football, shell, soccer
- Language: Shell
- Homepage:
- Size: 59.6 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# footy
A simple shell script that displays the latest football scores, fixtures and standings.
[](https://asciinema.org/a/dleQ7INJzcBYh4Q90u3UdOS9y)
## Table of Contents
- [Features](#features)
- [Install](#install)
- [Build from source](#build-from-source)
- [Usage](#usage)
- [Supported competitions and teams](#supported-competitions-and-teams)
- [Piping output to other tools](#piping-output-to-other-tools)
- [Dependencies](#dependencies)
- [License](#license)
## Features
- **Minimalistic output**: aiming to adhere to the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy), footy's output can easily be piped to other tools
- **Portable**: minimal [dependencies](#dependencies)
## Install
Since footy uses the data provided by [football-data.org](https://www.football-data.org/), an api-key is required.
You can register for one [here](https://www.football-data.org/client/register) for free.
Once footy is installed, set the api-key by running `footy -k ` or manually create the file `$HOME/.config/footy/api-key.txt` containing only the api-key.
### Build from source
```shell
git clone https://github.com/fritzrehde/footy.git
cd footy
sudo make install
```
**Note:** The makefile defaults to some default paths for installed files. Adjust to your system:
- `INSTALL_DIR`: PATH for executables (default /usr/local/bin)
```shell
make install INSTALL_DIR=/usr/bin
```
## Usage
```text
OPTIONS:
-s Prints standings/table
Must be used with -c
-m Prints upcoming ('+' suffix) or previous ('-' suffix) matches
Must be used with either -c or -t
-c Specifies competition (use code or id)
-t Specifies team (must use team's id)
-I Prints all supported competitions
-i Prints all teams in competition (use code or id)
-r Unformatted output for piping to other tools
-k Saves the api-key to $HOME/.config/footy/api-key.txt
-h Prints this help message
```
### Supported competitions and teams
`footy -I` gives you an overview of all the supported competitions (I recommend piping the output into a [pager](https://man7.org/linux/man-pages/man1/less.1.html)).
`footy -i BL1` or `footy -i 2002` prints all teams in the Bundesliga using either the *Code* `BL1` or the *Id* `2002`.
Some competitions do not have a *Code* and teams never have a *Code*, so you will have to use the *Id* there.
**Note**: Access to some of the smaller competitions/teams is paid ([pricing](https://www.football-data.org/coverage)). Therefore, the *Price* column shows which competitions are free.
### Piping output to other tools
The `-r` option provides unformatted output, where the columns are seperated by commas instead of whitespaces and the match dates are in the ISO-8601 UTC format.
#### Example
```
footy -s -c BL1 -r | cut -d ',' -f 1-6,10 | column -ts ','
```
This command will only display the first six and the tenth column of the standings output.
## Dependencies
- [`jq`](https://github.com/stedolan/jq): JSON processor
## License
The MIT License © Fritz Rehde