Skip to content
This repository was archived by the owner on Dec 22, 2023. It is now read-only.

Commit 5d8aeaa

Browse files
[ADD] documentation for using the script
1 parent f9df4e3 commit 5d8aeaa

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Football Standings CLI
2+
3+
Fetches the latest standings of major football leagues and displays the standings right in your terminal!
4+
5+
### Prerequisites
6+
7+
This script requires a **free** API Key from [football-data.org](https://www.football-data.org/) for fetching the up-to-date standings of leagues.
8+
9+
Save the Key obtained in **.env** file as follows:
10+
11+
**Before:**
12+
```bash
13+
API_KEY=YOUR_KEY_HERE
14+
```
15+
16+
**After:**
17+
```bash
18+
API_KEY=xxxxxxxxxxxxxxxxxx
19+
```
20+
> NOTE: No spaces around `=` as this is a shell file
21+
22+
**Python prerequisites:**
23+
24+
Run this command to install all required packages.
25+
26+
```bash
27+
$pip install -r requirements.txt
28+
```
29+
30+
### How to run the script
31+
32+
```bash
33+
$python3 main.py --help | -h # For displaying league codes of supported leagues
34+
$python3 main.py [league_code] # For displaying realtime standings of the league
35+
```
36+
### Screenshot/GIF showing the sample use of the script
37+
38+
![Screenshot of output](./output.png)
39+
40+
41+
## Author:
42+
43+
[Mahesh Bharadwaj K](https://github.com/MaheshBharadwaj)
184 KB
Loading
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
requests==2.20.0
2+
python-dotenv==0.14.0

0 commit comments

Comments
 (0)