You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): add worldcup dataset, fix typos and script paths
- Add FIFA World Cup dataset to the list of datasets
- Fix duplicate/typo preparation steps (pyhton → python, clarify process.py vs package.py)
- Fix script path: python package.py → python scripts/package.py
- Split license section to correctly attribute CC-BY-SA 4.0 for worldcup data
Copy file name to clipboardExpand all lines: README.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,16 @@
2
2
3
3
# Football datasets
4
4
5
-
This repository includes 5 major Europe leagues:
5
+
This repository includes 5 major Europe leagues and a World Cup dataset:
6
6
7
7
- English Premier League – https://datahub.io/football/english-premier-league
8
8
- Spanish La Liga – https://datahub.io/football/spanish-la-liga
9
9
- Italian Serie A – https://datahub.io/football/italian-serie-a
10
10
- German Bundesliga – https://datahub.io/football/german-bundesliga
11
11
- French Ligue 1 – https://datahub.io/football/french-ligue-1
12
+
- FIFA World Cup – https://datahub.io/football/worldcup
12
13
13
-
Each league has data for the all the seasons. The data is updated on daily basis via Github-Actions.
14
+
Each league has data for all the seasons. The data is updated on a daily basis via GitHub Actions.
14
15
15
16
## Data
16
17
@@ -21,17 +22,19 @@ The data is sourced from the `https://www.football-data.co.uk/` website, dataset
21
22
You need to have Python version >=3.5:
22
23
23
24
- Install requirements using `pip install -r scripts/requirements.txt`
24
-
-Run the script`python scripts/process.py`
25
-
-Update datapackage`pyhton scripts/process.py`
25
+
-Fetch and process league data:`python scripts/process.py`
26
+
-Generate datapackage.json for each dataset: `python scripts/package.py`
26
27
27
28
## Automation
28
29
29
30
Up-to-date (auto-updates every day) football dataset could be found on the datahub.io: https://datahub.io/football/football-datasets
30
31
31
32
## Packaging datasets
32
33
33
-
Each directory in `datasets/` directory is a data package. It has a common `schema.json` for all its resources. You need to run `python package.py` from root directory to generate `datapackage.json` for each data package.
34
+
Each directory in `datasets/` directory is a data package. It has a common `schema.json` for all its resources. You need to run `python scripts/package.py` from the root directory to generate `datapackage.json` for each data package.
34
35
35
36
## License
36
37
37
-
This Data Package is made available under the Public Domain Dedication and License v1.0 whose full text can be found at: http://www.opendatacommons.org/licenses/pddl/1.0/
38
+
The league datasets are made available under the Public Domain Dedication and License v1.0 whose full text can be found at: http://www.opendatacommons.org/licenses/pddl/1.0/
39
+
40
+
The World Cup dataset is derived from the [Fjelstul World Cup Database](https://github.com/jfjelstul/worldcup) and is published under the [Creative Commons Attribution-ShareAlike 4.0 International (CC-BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/) license. Attribution: Joshua C. Fjelstul, Ph.D.
0 commit comments