UFCData 0.4.0__tar.gz → 0.5.0__tar.gz

{ufcdata-0.4.0 → ufcdata-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UFCData
-Version: 0.4.0
+Version: 0.5.0
 Summary: Obtain UFC data and functions to manipulate it
 Requires-Python: >=3.10
 License-File: LICENSE.md

{ufcdata-0.4.0 → ufcdata-0.5.0}/README.md

@@ -9,6 +9,7 @@ add helper functions like convert odds
 ## Table of Contents
 
 - [Installation](#installation)
+- [Updating the Package](#updating-the-package)
 
 Accessing Data
   - [Loading Data](#loading-data)
@@ -19,7 +20,7 @@ Rating Function
 
 Fighter Functions
 - [Fighter History](#fighter-history)
-- [Fighter Statistic](#fighter-statistics)
+- [Fighter Statistic](#fighter-statistic)
 
 Helper Functions
   - [Odds Convert](#elo)
@@ -41,6 +42,12 @@ Data Sources
 pip install ufcdata
 ```
 
+## Updating the Package
+
+```bash
+pip install --no-cache-dir --upgrade ufcdata
+```
+
 ##  Loading Data
 
 ```python
@@ -192,7 +199,7 @@ jon_jones_history = ufc.get_fighter_history(
 
 This function is useful for analyzing an individual fighter's career, constructing fighter-level features, or preparing historical data for predictive modeling.
 
-## Fighter Statistics
+## Fighter Statistic
 
 
 The function `get_fighter_statistic()`, transforms a fighter's UFC fight history into a time-series dataset where each row represents the fighter's statistics **as they were known before a particular fight**.
@@ -276,85 +283,33 @@ This makes the data suitable for constructing historical features for a predicti
 ### Example
 
 ```python
-current_statistic, past_statistic = get_fighter_statistic(
-    fighter_link=fighter_link,
-    fighter_bio=fighter_bio,
-    fights_df=fights_df,
-    rounds_df=rounds_df,
-)
-```
-
-
-## Data Requirements
-
-The function expects the input DataFrames to contain the relevant fighter, fight, and round-level information.
-
-### `fighter_bio`
-
-Must contain at least:
-
-```text
-Name
-Fighter Link
-```
-
-### `fights_df`
-
-Must contain fighter links, outcomes, fight dates, and fight metadata required by the function.
-
-### `rounds_df`
-
-Must contain round-level striking, takedown, submission, and control statistics.
-
-### `future_df`
-
-Must contain:
+import ufcdata as ufc
 
-```text
-Date
-```
+data = ufc.get_data()
 
-The first row is used to determine the date of the upcoming fight.
+fighter_bio = data["fighter_bio"].copy()
+fights_df = data["past_fights"].copy()
+rounds_df = data['past_rounds'].copy()
+future_df = data['future_fights']
 
-## Design
+# Obtain Jon Jones' UFCStats link
+jon_jones = ufc.search(
+    fighter_bio,
+    "Name",
+    "Jon Jones"
+).iloc[0]["Fighter Link"]
 
-The function follows this general pipeline:
+# Get Jon Jones' statistic
+jon_jones_current, jon_jones_past = ufc.get_fighter_statistic(
+    jon_jones,
+    fighter_bio,
+    fights_df,
+    rounds_df
+)
 
-```text
-Fighter
-   │
-   ▼
-Retrieve fight history
-   │
-   ▼
-Construct chronological fight history
-   │
-   ▼
-Calculate UFC record
-   │
-   ▼
-Calculate Elo ratings
-   │
-   ▼
-Calculate cumulative fight statistics
-   │
-   ├── Striking
-   ├── Takedowns
-   └── Submissions
-   │
-   ▼
-Generate pre-fight statistics
-   │
-   ├── Past fights
-   └── Upcoming fight
-   │
-   ▼
-Return current_statistic, past_statistic
+jon_jones_current
 ```
 
-The resulting data can then be combined with opponent statistics and other fight-level features to create inputs for UFC fight prediction models.
-
-
 
 ## Online Sources
 

{ufcdata-0.4.0 → ufcdata-0.5.0}/UFCData.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UFCData
-Version: 0.4.0
+Version: 0.5.0
 Summary: Obtain UFC data and functions to manipulate it
 Requires-Python: >=3.10
 License-File: LICENSE.md

{ufcdata-0.4.0 → ufcdata-0.5.0}/UFCData.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ UFCData.egg-info/top_level.txt
 ufcdata/__init__.py
 ufcdata/data.py
 ufcdata/fighter.py
+ufcdata/helper.py
 ufcdata/ratings.py
 ufcdata/search.py
 ufcdata.egg-info/PKG-INFO

{ufcdata-0.4.0 → ufcdata-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "UFCData"
-version = "0.4.0"
+version = "0.5.0"
 description = "Obtain UFC data and functions to manipulate it"
 requires-python = ">=3.10"
 

ufcdata-0.5.0/ufcdata/__init__.py

@@ -0,0 +1,5 @@
+from .data import get_data
+from .search import search
+from .ratings import get_elo
+from .fighter import get_fighter_history, get_fighter_statistic
+from .helper import convert_odds, convert_gender, convert_weight, mirror

ufcdata-0.5.0/ufcdata/helper.py

@@ -0,0 +1,145 @@
+import re
+import pandas as pd
+import numpy as np
+
+def convert_odds(odds, probability=False):
+    """
+    Convert American betting odds to a numeric value or implied probability.
+
+    Parameters
+    ----------
+    odds : str, int, float, or None
+        American betting odds. The function extracts the first signed or
+        unsigned integer from the input. Missing values return None.
+
+    probability : bool, default=False
+        If False, return the extracted American odds as an integer.
+        If True, return the implied probability as a decimal.
+
+    Returns
+    -------
+    int or float or None
+        The extracted American odds if probability=False, otherwise the
+        implied probability. Returns None for missing values.
+
+    Examples
+    --------
+    >>> convert_odds("+120")
+    120
+    >>> convert_odds("-400")
+    -400
+    >>> convert_odds("-400", probability=True)
+    0.8
+    """
+    if pd.isna(odds):
+        return None
+
+    odds = int(re.search(r'[+-]?\d+', str(odds)).group())
+
+    if not probability:
+        return odds
+
+    if odds < 0:
+        return -odds / (-odds + 100)
+    else:
+        return 100 / (odds + 100)
+
+def convert_gender(gender):
+    """
+    Convert a gender label to a binary numeric value.
+
+    Parameters
+    ----------
+    gender : str
+        Gender label. "Male" is mapped to 1 and "Female" is mapped to 0.
+
+    Returns
+    -------
+    int or None
+        1 for "Male", 0 for "Female", and None for unrecognized or missing values.
+    """
+    if gender == "Male":
+        return 1
+    elif gender == "Female":
+        return 0
+    else:
+        return None
+
+
+def convert_weight(weight):
+    """
+    Convert a weight class label to its corresponding weight limit in pounds.
+
+    Parameters
+    ----------
+    weight : str
+        Weight class label to convert.
+
+    Returns
+    -------
+    float
+        Weight limit in pounds for recognized weight classes. Returns NaN for
+        catch weight, open weight, unrecognized weight classes, or missing values.
+    """
+    weight_map = {
+        "Strawweight": 115,
+        "Flyweight": 125,
+        "Bantamweight": 135,
+        "Featherweight": 145,
+        "Lightweight": 155,
+        "Welterweight": 170,
+        "Middleweight": 185,
+        "Light Heavyweight": 205,
+        "Heavyweight": 265,
+        "Super Heavyweight": 265,
+        "Catch Weight": np.nan,
+        "Open Weight": np.nan,
+    }
+    return weight_map.get(weight.strip(), np.nan)
+
+
+def mirror(df, cols_1, cols_2, in_order=True):
+    """
+    Create mirrored versions of a DataFrame by swapping paired columns.
+
+    Parameters
+    ----------
+    df : pandas.DataFrame
+        Input DataFrame to mirror.
+    cols_1 : list-like
+        Column names representing the first side of each pair.
+    cols_2 : list-like
+        Column names representing the second side of each pair. Each column
+        is swapped with the corresponding column in `cols_1`.
+    in_order : bool, default=True
+        Determines the order of rows in the returned DataFrame. If True,
+        each original row is immediately followed by its mirrored row.
+        If False, all original rows are followed by all mirrored rows.
+
+    Returns
+    -------
+    pandas.DataFrame
+        DataFrame containing the original and mirrored rows.
+
+    Notes
+    -----
+    The input DataFrame is copied and is not modified in place.
+    """
+    df = df.copy()
+    df_original = df.copy()
+
+    # Swap each pair of columns
+    for c1, c2 in zip(cols_1, cols_2):
+        temp = df[c1].copy()
+        df[c1] = df[c2]
+        df[c2] = temp
+
+    if not in_order:
+        return pd.concat([df_original, df], ignore_index=True)
+
+    rows = []
+    for r1, r2 in zip(df_original.itertuples(index=False), df.itertuples(index=False)):
+        rows.append(r1)
+        rows.append(r2)
+
+    return pd.DataFrame(rows, columns=df.columns)

ufcdata-0.4.0/ufcdata/__init__.py

@@ -1,4 +0,0 @@
-from .data import get_data
-from .search import search
-from .ratings import get_elo
-from .fighter import get_fighter_history