https://github.com/architv/soccer-cli
:soccer: Football scores for hackers. :computer: A command line interface for all the football scores.
https://github.com/architv/soccer-cli
Last synced: 8 months ago
JSON representation
:soccer: Football scores for hackers. :computer: A command line interface for all the football scores.
- Host: GitHub
- URL: https://github.com/architv/soccer-cli
- Owner: architv
- License: mit
- Created: 2015-08-16T18:06:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T21:34:32.000Z (over 2 years ago)
- Last Synced: 2025-04-07T03:14:35.926Z (9 months ago)
- Language: Python
- Homepage:
- Size: 213 KB
- Stars: 1,106
- Watchers: 83
- Forks: 223
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-football - architv/soccer-cli - command line tool for league table standings, match scores and more (in Python) using an HTTP JSON API (Football Apps / Misc)
- awesome-terminals - soccer - ⚽️ Football scores for hackers. 💻 A command line interface for all the football scores. (Tools / Python)
README
Soccer CLI
=====
[](http://badge.fury.io/py/soccer-cli) [](https://gitter.im/architv/soccer-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://repl.it/github/architv/soccer-cli)
Soccer for Hackers - a CLI for all the football scores.
Install
=====
An API key from [football-data.org](http://api.football-data.org/) will be required and you can register for one [here](http://api.football-data.org/client/register).
### Build from source
```bash
$ git clone https://github.com/architv/soccer-cli.git
$ cd soccer-cli
$ python setup.py install
```
You can set the API key using an environment variable as shown above or create a file `.soccer-cli.ini` in your home folder (`/home/username/.soccer-cli.ini`) that contains only your API token, such that:
```bash
$ cat /home/username/.soccer-cli.ini
```
#### Note:
Currently supports Linux, Mac OS X, NetBSD, FreeBSD and Windows.
To get colorized terminal output on Windows, make sure to install [ansicon](https://github.com/adoxa/ansicon/releases/latest) and [colorama](https://pypi.org/project/colorama/).
Usage
====
### Get standings for a league
```bash
$ soccer --standings --league=PL # PL is the league code for English Premier League
```
### Get scores for a particular team
```bash
$ soccer --team=MUFC # MUFC is the team code for Manchester United
$ soccer --team=PSG --time=10 # scores for all the Paris Saint-Germain games over the past 10 days
```
### Get upcoming fixtures
```bash
$ soccer --time 5 --upcoming # get upcoming fixtures for next 5 days
$ soccer --time 5 --upcoming --use12hour # upcoming fixture for next 5 days with timings in 12 hour format
```
### Get scores for live games
```bash
$ soccer --live
```
### Get scores for a particular league
```bash
$ soccer --league=BL # BL is the league code for Bundesliga
$ soccer --league=FL --time=15 # get scores for all the French Ligue games over the past 15 days
```
### Get information about players of a team
```bash
$ soccer --team=JUVE --players
```
### Get scores for all seven leagues with a set time period
```bash
$ soccer --time=10 # get scores for all the seven leagues over the past 10 days
```
### Get the output in csv or json
```bash
$ soccer --league PL --standings --csv # prints the output in csv format
$ soccer --league PL --standings --json # prints the output in json format
```
### Store the ouput in a file
```bash
$ soccer --league PL --standings --csv -o 'standings.csv' # stores the ouput in csv format in `standings.csv`
```
### Help
```bash
$ soccer --help
```
### List of supported leagues and their league codes
- World:
- WC: World Cup (if running/active)
- Europe:
- CL: Champions League
- EC: European Championships (if running/active)
- Brazil:
- BSA: Brazil Serie A
- England:
- PL: English Premier League
- ELC: English Championship
- France:
- FL1: Ligue 1
- Germany:
- BL: Bundesliga
- Italy:
- SA: Serie A
- Netherlands:
- DED: Eredivisie
- Portugal:
- PPL: Primeira Liga
- Spain:
- LLIGA: La Liga
### Team and team codes
For a full list of supported team and team codes [see this](soccer/teams.json).
### Tests
To run testing suite from root of repo
```bash
$ python -m unittest discover tests
```
To run specific test file (in this case the tests in test_request_handler.py)
```bash
$ python -m unittest tests.test_request_handler
```
Demo
====
### Standings
### Live scores
### Team scores
### Output in json format
Todo
====
- [ ] Enable cache.
- [ ] Add more test cases.
- [x] Add fixtures for UEFA Champions League.
- [ ] Add league filter for live scores.
- [x] Color coding for Europa league and differentiation between straight CL and CL playoff spots, and the same for EL spots.
- [x] Add support for team line up.
- [ ] A built in watch feature so you can run once with --live and just leave the program running.
- [ ] Python 3 support.
Licence
====
Open sourced under [MIT License](LICENSE)
Support
====
If you like my work, please support the project by donating.
- https://gratipay.com/~architv