datafc 1.2.0__tar.gz → 1.4.0__tar.gz

{datafc-1.2.0 → datafc-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datafc
-Version: 1.2.0
+Version: 1.4.0
 Summary: A scalable Python library for fetching, processing, and exporting structured football match data.
 Home-page: https://github.com/urazakgul/datafc
 Author: Uraz Akgül
@@ -14,7 +14,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-# datafc v1.2.0
+# datafc v1.4.0
 
 ## Overview
 
@@ -53,7 +53,7 @@ pip install git+https://github.com/urazakgul/datafc.git
 To install a specific version of `datafc`, use:
 
 ```bash
-pip install datafc==1.2.0
+pip install datafc==1.4.0
 ```
 
 If you already have `datafc` installed and want to upgrade to the latest version, run:
@@ -105,6 +105,7 @@ from datafc.sofascore import (
     match_odds_data,
     match_stats_data,
     momentum_data,
+    past_matches_data,
     lineups_data,
     coordinates_data,
     substitutions_data,
@@ -140,20 +141,19 @@ The `lineups_data` function fetches player lineup details for each match and is
 
 Without `lineups_data`, these dependent functions will not work as expected.
 
-Exception: `standings_data`
+Exception: `standings_data` and `past_matches_data`
 
-Unlike the other functions, `standings_data` does not require `match_data` or `lineups_data`. It can be executed independently using only `tournament_id` and `season_id`.
+Unlike other functions, `standings_data` and `past_matches_data` do not require `match_data` or `lineups_data`. They can be executed independently using only `tournament_id` and `season_id`. Additionally, `past_matches_data` includes an extra field: `week_number`.
 
 ### Match Data
 
 #### `match_data`
 
-The `match_data` function fetches match data for a specified tournament, season, and matchweek. It returns a DataFrame containing details such as country, tournament name, season, week number, game ID, home team, home team ID, away team, away team ID, added injury times for both halves, start timestamp, match status, and score-related information.
+The `match_data` function fetches match data for a specified tournament, season, and matchweek.
 
 Example Usage:
 
 ```python
-# Fetch match data for a specific tournament, season, and week
 match_df = match_data(
     tournament_id=52,
     season_id=63814,
@@ -164,15 +164,52 @@ match_df = match_data(
 )
 
 print(match_df)
+
+uefa_match_df = match_data(
+    tournament_id=7,
+    season_id=61644,
+    week_number=5,
+    tournament_type="uefa",
+    tournament_stage="round_of_16",
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_match_df)
 ```
 
 Parameters:
 
 * `tournament_id` (int): The unique identifier for the tournament.
 * `season_id` (int): The unique identifier for the season.
-* `week_number` (int): The matchweek number within the season.
+* `week_number` (int): The matchweek number within the season. The applicable week numbers depend on the tournament and stage, as outlined below for the 2024/25 season:
+  * UCL, UEL, UECL, and UNL:
+    * `qualification_round`: 1, 2, 3
+    * `qualification_playoff`: 636
+    * `group_stage_week`: 1, 2, 3, ..., 8 (for UNL, up to 6)
+    * `playoff_round`: 636
+    * `round_of_16`: 5
+    * `quarterfinals`: 27
+    * `semifinals`: 28
+    * `final`: 29
+  * Domestic Leagues:
+    * Use the corresponding matchweek number (e.g., for the 10th week of the season, enter `week_number=10`).
+* `tournament_type` (str, optional): The tournament type (`uefa`). If `None`, assumes league format.
+* `tournament_stage` (str, optional): The specific stage of the tournament. Available options for UEFA tournaments:
+  * `preliminary_final`
+  * `preliminary_final`
+  * `qualification_round`
+  * `qualification_playoff`
+  * `group_stage_week`
+  * `playoff_round`
+  * `round_of_16`
+  * `quarterfinals`
+  * `semifinals`
+  * `match_for_3rd_place`
+  * `final`
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -210,12 +247,11 @@ Dependencies:
 
 #### `match_odds_data`
 
-The `match_odds_data` function fetches betting odds data for each match in the provided match dataset. It returns a DataFrame containing match odds details, including market names, odds values, and whether the odds changed.
+The `match_odds_data` function fetches betting odds data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch match odds data
 match_odds_df = match_odds_data(
     match_df=match_df,
     data_source="sofascore",
@@ -224,13 +260,22 @@ match_odds_df = match_odds_data(
 )
 
 print(match_odds_df)
+
+uefa_match_odds_df = match_odds_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_match_odds_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -258,12 +303,11 @@ Dependencies:
 
 #### `match_stats_data`
 
-The `match_stats_data` function fetches statistical data for each match in the provided match dataset. It returns a DataFrame containing key match statistics, including team performance metrics.
+The `match_stats_data` function fetches statistical data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch match statistics data
 match_stats_df = match_stats_data(
     match_df=match_df,
     data_source="sofascore",
@@ -272,13 +316,22 @@ match_stats_df = match_stats_data(
 )
 
 print(match_stats_df)
+
+uefa_match_stats_df = match_stats_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_match_stats_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -303,12 +356,11 @@ Dependencies:
 
 #### `momentum_data`
 
-The `momentum_data` function fetches momentum data for each match in the provided match dataset. It returns a DataFrame containing match momentum values over time.
+The `momentum_data` function fetches momentum data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch momentum data
 momentum_df = momentum_data(
     match_df=match_df,
     data_source="sofascore",
@@ -317,13 +369,22 @@ momentum_df = momentum_data(
 )
 
 print(momentum_df)
+
+uefa_momentum_df = momentum_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_momentum_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -343,16 +404,113 @@ Dependencies:
 
 * Requires `match_data` output as `match_df`.
 
+#### `past_matches_data`
+
+The `past_matches_data` function fetches past match data for a specified tournament, season, and week number.
+
+Example Usage:
+
+```python
+past_matches_df = past_matches_data(
+    tournament_id=52,
+    season_id=63814,
+    week_number=21,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(past_matches_df)
+
+uefa_past_matches_df = past_matches_data(
+    tournament_id=7,
+    season_id=61644,
+    week_number=5,
+    tournament_type="uefa",
+    tournament_stage="round_of_16",
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_past_matches_df)
+```
+
+Parameters:
+
+* `tournament_id` (int): The unique identifier for the tournament.
+* `season_id` (int): The unique identifier for the season.
+* `week_number` (int): The matchweek number within the season. The applicable week numbers depend on the tournament and stage, as outlined below for the 2024/25 season:
+  * UCL, UEL, UECL, and UNL:
+    * `qualification_round`: 1, 2, 3
+    * `qualification_playoff`: 636
+    * `group_stage_week`: 1, 2, 3, ..., 8 (for UNL, up to 6)
+    * `playoff_round`: 636
+    * `round_of_16`: 5
+    * `quarterfinals`: 27
+    * `semifinals`: 28
+    * `final`: 29
+  * Domestic Leagues:
+    * Use the corresponding matchweek number (e.g., for the 10th week of the season, enter `week_number=10`).
+* `tournament_type` (str, optional): The tournament type (`uefa`). If `None`, assumes league format.
+* `tournament_stage` (str, optional): The specific stage of the tournament. Available options for UEFA tournaments:
+  * `preliminary_final`
+  * `preliminary_final`
+  * `qualification_round`
+  * `qualification_playoff`
+  * `group_stage_week`
+  * `playoff_round`
+  * `round_of_16`
+  * `quarterfinals`
+  * `semifinals`
+  * `match_for_3rd_place`
+  * `final`
+* `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
+* `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
+* `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
+
+Data Structure:
+
+The returned DataFrame includes the following columns:
+
+* `country`: The country where the tournament is held.
+* `tournament`: The name of the tournament.
+* `season`: The season year.
+* `week`: The matchweek number.
+* `game_id`: The unique identifier for the match.
+* `home_team`: The name of the home team.
+* `home_team_id`: The unique identifier for the home team.
+* `away_team`: The name of the away team.
+* `away_team_id`: The unique identifier for the away team.
+* `injury_time_1`: Added injury time in the first half.
+* `injury_time_2`: Added injury time in the second half.
+* `start_timestamp`: The start time of the match.
+* `status`: The current status of the match.
+* `home_score_current`: The latest recorded score for the home team.
+* `home_score_display`: The displayed score of the home team.
+* `home_score_period1`: The home team's score at the end of the first half.
+* `home_score_period2`: The home team's goals scored in the second half.
+* `home_score_normaltime`: The home team's final score at the end of normal time (90 minutes).
+* `away_score_current`: The latest recorded score for the away team.
+* `away_score_display`: The displayed score of the away team.
+* `away_score_period1`: The away team's score at the end of the first half.
+* `away_score_period2`: The away team's goals scored in the second half.
+* `away_score_normaltime`: The away team's final score at the end of normal time (90 minutes).
+
+Dependencies:
+
+* No prior function dependency required.
+
 ### Player Data
 
 #### `lineups_data`
 
-The `lineups_data` function fetches lineup data for each match in the provided match dataset. It returns a DataFrame containing lineup details such as country, tournament name, season, week number, game ID, team, player name, player ID, statistic name, and statistic value.
+The `lineups_data` function fetches lineup data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch lineups data based on match data
 lineups_df = lineups_data(
     match_df=match_df,
     data_source="sofascore",
@@ -361,13 +519,22 @@ lineups_df = lineups_data(
 )
 
 print(lineups_df)
+
+uefa_lineups_df = lineups_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_lineups_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -392,12 +559,11 @@ Dependencies:
 
 #### `coordinates_data`
 
-The `coordinates_data` function fetches coordinate data for each player in the provided lineup dataset. It returns a DataFrame containing coordinate details such as country, tournament name, season, week number, game ID, team, player ID, player name, and x-y coordinates.
+The `coordinates_data` function fetches coordinate data for each player in the provided lineup dataset.
 
 Example Usage:
 
 ```python
-# Fetch coordinates data
 coordinates_df = coordinates_data(
     lineups_df=lineups_df,
     data_source="sofascore",
@@ -406,13 +572,22 @@ coordinates_df = coordinates_data(
 )
 
 print(coordinates_df)
+
+uefa_coordinates_df = coordinates_data(
+    lineups_df=uefa_lineups_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_coordinates_df)
 ```
 
 Parameters:
 
 * `lineups_df` (pd.DataFrame): A DataFrame containing player and match metadata, which should be generated by the `lineups_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -437,12 +612,11 @@ Dependencies:
 
 #### `substitutions_data`
 
-The `substitutions_data` function fetches substitution data for each match in the provided match dataset. It returns a DataFrame containing details of player substitutions, including the players involved and the time of the substitution.
+The `substitutions_data` function fetches substitution data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch substitution data
 substitutions_df = substitutions_data(
     match_df=match_df,
     data_source="sofascore",
@@ -451,13 +625,22 @@ substitutions_df = substitutions_data(
 )
 
 print(substitutions_df)
+
+uefa_substitutions_df = substitutions_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_substitutions_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -484,12 +667,11 @@ Dependencies:
 
 #### `goal_networks_data`
 
-The `goal_networks_data` function fetches goal network data for each match in the provided match dataset. It returns a DataFrame containing goal-related events, including passing networks and shot locations.
+The `goal_networks_data` function fetches goal network data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch goal networks data
 goal_networks_df = goal_networks_data(
     match_df=match_df,
     data_source="sofascore",
@@ -498,13 +680,22 @@ goal_networks_df = goal_networks_data(
 )
 
 print(goal_networks_df)
+
+uefa_goal_networks_df = goal_networks_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_goal_networks_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -541,12 +732,11 @@ Dependencies:
 
 #### `shots_data`
 
-The `shots_data` function fetches shot data for each match in the provided match dataset. It returns a DataFrame containing detailed shot-related information, including player coordinates, xG values, shot types, and goal mouth locations.
+The `shots_data` function fetches shot data for each match in the provided match dataset.
 
 Example Usage:
 
 ```python
-# Fetch shot data
 shots_df = shots_data(
     match_df=match_df,
     data_source="sofascore",
@@ -555,13 +745,22 @@ shots_df = shots_data(
 )
 
 print(shots_df)
+
+uefa_shots_df = shots_data(
+    match_df=uefa_match_df,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_shots_df)
 ```
 
 Parameters:
 
 * `match_df` (pd.DataFrame): A DataFrame containing match metadata, which should be generated by the `match_data` function.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -608,12 +807,11 @@ Dependencies:
 
 #### `standings_data`
 
-The `standings_data` function fetches league standings for a specific tournament and season. It returns a DataFrame containing team rankings, match results, and points.
+The `standings_data` function fetches league standings for a specific tournament and season.
 
 Example Usage:
 
 ```python
-# Fetch league standings
 standings_df = standings_data(
     tournament_id=52,
     season_id=63814,
@@ -623,6 +821,16 @@ standings_df = standings_data(
 )
 
 print(standings_df)
+
+uefa_standings_df = standings_data(
+    tournament_id=7,
+    season_id=61644,
+    data_source="sofascore",
+    enable_json_export=True,
+    enable_excel_export=True
+)
+
+print(uefa_standings_df)
 ```
 
 Parameters:
@@ -630,7 +838,7 @@ Parameters:
 * `tournament_id` (int): The unique identifier for the tournament.
 * `season_id` (int): The unique identifier for the season.
 * `data_source` (str): The data source (`sofavpn` or `sofascore`). Defaults to `sofascore`.
-* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to 10.
+* `element_load_timeout` (int): The maximum time (in seconds) to wait for the API response. Defaults to `10`.
 * `enable_json_export` (bool): If `True`, exports the fetched data as a JSON file. Defaults to `False`.
 * `enable_excel_export` (bool): If `True`, exports the fetched data as an Excel file. Defaults to `False`.
 
@@ -658,6 +866,13 @@ Dependencies:
 
 ## Changelog
 
+* v1.4.0
+  * Added `tournament_type` and `tournament_stage` parameters to `match_data` and `past_matches_data` functions.
+  * Extended support for UEFA tournaments, including UEFA Champions League (UCL), UEFA Europa League (UEL), UEFA Europa Conference League (UECL), and UEFA Nations League (UNL), allowing seamless data fetching across multiple competitions.
+
+* v1.3.0
+  * Added `past_matches_data` function to fetch historical match data.
+
 * v1.2.0
   * Added match score columns to `match_data`