impectPy 2.5.9__tar.gz → 2.5.10__tar.gz

{impectpy-2.5.9 → impectpy-2.5.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: impectPy
-Version: 2.5.9
+Version: 2.5.10
 Summary: A Python package to facilitate interaction with the Impect customer API
 Home-page: https://github.com/ImpectAPI/impectPy
 Author: Impect
@@ -25,9 +25,9 @@ Dynamic: summary
 
 A package provided by: Impect GmbH
 
-Version: v2.5.9
+Version: v2.5.10
 
-**Updated: April 9th 2026**
+**Updated: April 13th 2026**
 
 ---
 
@@ -58,7 +58,7 @@ pip install impectPy
 You can also install it from [GitHub](https://github.com/) with:
 
 ```cmd
-pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.9
+pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.10
 ```
 
 ## Usage
@@ -302,6 +302,15 @@ calls made on the client side already. The rate limit is read from the first lim
 policy sent back by the API, so if this limit increases over time, this package will
 act accordingly.
 
+### Generic API Call
+You can also use this package to make individual API calls querying a specific endpoint 
+such as the "squads" endpoint.
+
+```python
+# query any IMPECT customer API endpoint
+data = ip.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads", token=token)
+```
+
 ### SportsCodeXML
 
 It is also possible to convert a dataframe containing event data into an XML file,
@@ -449,6 +458,9 @@ squadIterationScores = api.getSquadIterationScores(iteration=iteration)
 
 # get player profile scores
 playerProfileScores = api.getPlayerProfileScores(iteration=iteration, positions=positions)
+
+# query single API endpoint (e.g. squads for iteration 518)
+data = api.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads")
 ```
 
 ## Final Notes

{impectpy-2.5.9 → impectpy-2.5.10}/README.md

@@ -2,9 +2,9 @@
 
 A package provided by: Impect GmbH
 
-Version: v2.5.9
+Version: v2.5.10
 
-**Updated: April 9th 2026**
+**Updated: April 13th 2026**
 
 ---
 
@@ -35,7 +35,7 @@ pip install impectPy
 You can also install it from [GitHub](https://github.com/) with:
 
 ```cmd
-pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.9
+pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.10
 ```
 
 ## Usage
@@ -279,6 +279,15 @@ calls made on the client side already. The rate limit is read from the first lim
 policy sent back by the API, so if this limit increases over time, this package will
 act accordingly.
 
+### Generic API Call
+You can also use this package to make individual API calls querying a specific endpoint 
+such as the "squads" endpoint.
+
+```python
+# query any IMPECT customer API endpoint
+data = ip.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads", token=token)
+```
+
 ### SportsCodeXML
 
 It is also possible to convert a dataframe containing event data into an XML file,
@@ -426,9 +435,12 @@ squadIterationScores = api.getSquadIterationScores(iteration=iteration)
 
 # get player profile scores
 playerProfileScores = api.getPlayerProfileScores(iteration=iteration, positions=positions)
+
+# query single API endpoint (e.g. squads for iteration 518)
+data = api.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads")
 ```
 
 ## Final Notes
 
 Further documentation on the data and explanations of variables can be
-found in our [Glossary](https://glossary.impect.com/).
+found in our [Glossary](https://glossary.impect.com/).

{impectpy-2.5.9 → impectpy-2.5.10}/impectPy/__init__.py

@@ -1,5 +1,5 @@
 # define version attribute
-__version__ = "2.5.8"
+__version__ = "2.5.10"
 
 # import modules
 from .access_token import getAccessToken
@@ -22,5 +22,6 @@ from .squad_coefficients import getSquadCoefficients
 from .formations import getFormations
 from .substitutions import getSubstitutions
 from .starting_positions import getStartingPositions
+from .data import getData
 from .config import Config as Config
 from .impect import Impect as Impect

impectpy-2.5.10/impectPy/data.py

@@ -0,0 +1,54 @@
+# load packages
+import pandas as pd
+from typing import Optional, Dict, Any
+from impectPy.helpers import RateLimitedAPI, ImpectSession
+
+
+######
+#
+# This function returns a dataframe from any Impect API endpoint
+#
+######
+
+
+def getData(
+        url: str, token: str, method: str = "GET", data: Optional[Dict[str, Any]] = None,
+        session: Optional[ImpectSession] = None
+) -> pd.DataFrame:
+    """Returns a processed DataFrame from any Impect API endpoint.
+
+    Args:
+        url (str): Full URL of the API endpoint.
+        token (str): Bearer token for authentication.
+        method (str): HTTP method. Defaults to "GET".
+        data (Optional[Dict[str, Any]]): Optional request body. Defaults to None.
+        session (Optional[ImpectSession]): The session object to use for the API calls. Defaults to a new ImpectSession.
+
+    Returns:
+        pd.DataFrame: Processed response data.
+    """
+    # create an instance of RateLimitedAPI
+    connection = RateLimitedAPI(session or ImpectSession())
+
+    # set auth header
+    connection.session.headers.update({"Authorization": f"Bearer {token}"})
+
+    return getDataFromHost(url=url, method=method, connection=connection, data=data)
+
+
+def getDataFromHost(
+        url: str, method: str, connection: RateLimitedAPI, data: Optional[Dict[str, Any]] = None
+) -> pd.DataFrame:
+    """Core implementation: executes a rate-limited API call and returns a processed DataFrame.
+
+    Args:
+        url (str): Full URL of the API endpoint.
+        method (str): HTTP method.
+        connection (RateLimitedAPI): Authenticated connection object.
+        data (Optional[Dict[str, Any]]): Optional request body. Defaults to None.
+
+    Returns:
+        pd.DataFrame: Processed response data.
+    """
+    response = connection.make_api_request_limited(url=url, method=method, data=data)
+    return response.process_response(endpoint=url)

{impectpy-2.5.9 → impectpy-2.5.10}/impectPy/impect.py

@@ -1,4 +1,10 @@
+from typing import Optional, Dict, Any
+from xml.etree import ElementTree as ET
+
+import pandas as pd
+
 from impectPy.config import Config
+
 from .helpers import RateLimitedAPI
 from .access_token import getAccessTokenFromUrl
 from .iterations import getIterationsFromHost
@@ -20,8 +26,7 @@ from .squad_coefficients import getSquadCoefficientsFromHost
 from .formations import getFormationsFromHost
 from .substitutions import getSubstitutionsFromHost
 from .starting_positions import getStartingPositionsFromHost
-import pandas as pd
-from xml.etree import ElementTree as ET
+from .data import getDataFromHost
 
 
 class Impect:
@@ -130,6 +135,26 @@ class Impect:
             matches, self.connection, self.__config.HOST
         )
 
+    def getData(
+            self, url: str, method: str = "GET", data: Optional[Dict[str, Any]] = None
+    ) -> pd.DataFrame:
+        """Returns a processed DataFrame from any Impect API endpoint.
+
+        Accepts a full URL or a path. If a path is provided (does not start
+        with 'http'), the configured host is prepended automatically.
+
+        Args:
+            url (str): Full URL or path of the API endpoint.
+            method (str): HTTP method. Defaults to "GET".
+            data (Optional[Dict[str, Any]]): Optional request body. Defaults to None.
+
+        Returns:
+            pd.DataFrame: Processed response data.
+        """
+        if not url.startswith("http"):
+            url = f"{self.__config.HOST}{url}"
+        return getDataFromHost(url=url, method=method, connection=self.connection, data=data)
+
     @staticmethod
     def generateXML(
             events: pd.DataFrame,

{impectpy-2.5.9 → impectpy-2.5.10}/impectPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: impectPy
-Version: 2.5.9
+Version: 2.5.10
 Summary: A Python package to facilitate interaction with the Impect customer API
 Home-page: https://github.com/ImpectAPI/impectPy
 Author: Impect
@@ -25,9 +25,9 @@ Dynamic: summary
 
 A package provided by: Impect GmbH
 
-Version: v2.5.9
+Version: v2.5.10
 
-**Updated: April 9th 2026**
+**Updated: April 13th 2026**
 
 ---
 
@@ -58,7 +58,7 @@ pip install impectPy
 You can also install it from [GitHub](https://github.com/) with:
 
 ```cmd
-pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.9
+pip install git+https://github.com/ImpectAPI/impectPy.git@v2.5.10
 ```
 
 ## Usage
@@ -302,6 +302,15 @@ calls made on the client side already. The rate limit is read from the first lim
 policy sent back by the API, so if this limit increases over time, this package will
 act accordingly.
 
+### Generic API Call
+You can also use this package to make individual API calls querying a specific endpoint 
+such as the "squads" endpoint.
+
+```python
+# query any IMPECT customer API endpoint
+data = ip.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads", token=token)
+```
+
 ### SportsCodeXML
 
 It is also possible to convert a dataframe containing event data into an XML file,
@@ -449,6 +458,9 @@ squadIterationScores = api.getSquadIterationScores(iteration=iteration)
 
 # get player profile scores
 playerProfileScores = api.getPlayerProfileScores(iteration=iteration, positions=positions)
+
+# query single API endpoint (e.g. squads for iteration 518)
+data = api.getData(url=f"https://api.impect.com/v5/customerapi/iterations/{iteration}/squads")
 ```
 
 ## Final Notes

{impectpy-2.5.9 → impectpy-2.5.10}/impectPy.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.py
 impectPy/__init__.py
 impectPy/access_token.py
 impectPy/config.py
+impectPy/data.py
 impectPy/events.py
 impectPy/formations.py
 impectPy/generate_xml.py
@@ -29,4 +30,5 @@ impectPy.egg-info/PKG-INFO
 impectPy.egg-info/SOURCES.txt
 impectPy.egg-info/dependency_links.txt
 impectPy.egg-info/requires.txt
-impectPy.egg-info/top_level.txt
+impectPy.egg-info/top_level.txt
+tests/test_package.py

{impectpy-2.5.9 → impectpy-2.5.10}/setup.py

@@ -17,7 +17,7 @@ setup(
                       "pandas>=2.2.0",
                       "numpy>=1.24.2"],
     # *strongly* suggested for sharing
-    version="2.5.9",
+    version="2.5.10",
     # The license can be anything you like
     license="MIT",
     description="A Python package to facilitate interaction with the Impect customer API",

impectpy-2.5.10/tests/test_package.py

@@ -0,0 +1,291 @@
+# load packages
+import sys
+import importlib
+import logging
+import os
+import re
+import subprocess
+from pathlib import Path
+from tqdm import tqdm
+from dotenv import load_dotenv
+import pandas as pd
+
+execute_functions = True
+
+# branch comparison configuration
+BRANCH_A_NAME = "main"
+BRANCH_B_NAME = "release"
+
+REPO_ROOT = Path(__file__).resolve().parents[1]
+BRANCH_PATHS = {
+    BRANCH_A_NAME: REPO_ROOT,
+    BRANCH_B_NAME: REPO_ROOT,
+}
+
+
+def checkout_branch(branch_name: str):
+    repo_path = BRANCH_PATHS.get(branch_name)
+    if repo_path is None or not repo_path.exists():
+        raise ValueError(f"Unknown branch or missing repo path: '{branch_name}'")
+
+    try:
+        subprocess.run(
+            ["git", "-C", str(repo_path), "fetch"],
+            check=True,
+            stdout=subprocess.DEVNULL
+        )
+        subprocess.run(
+            ["git", "-C", str(repo_path), "checkout", branch_name],
+            check=True,
+            stdout=subprocess.DEVNULL
+        )
+    except subprocess.CalledProcessError as e:
+        print(f"Error checking out branch '{branch_name}' in {repo_path}: {e}")
+
+
+def load_impect(env: str):
+    modules_to_remove = [m for m in sys.modules if m.startswith("impectPy")]
+
+    for module_name in modules_to_remove:
+        del sys.modules[module_name]
+
+    sys.path = [p for p in sys.path if "impectPy" not in p]
+
+    importlib.invalidate_caches()
+
+    repo_root = BRANCH_PATHS.get(env)
+    if repo_root is None:
+        raise ValueError(f"Unknown environment '{env}'. Check BRANCH_PATHS.")
+
+    sys.path.insert(0, str(repo_root))
+    return importlib.import_module("impectPy")
+
+if execute_functions:
+
+    # define login credentials
+    load_dotenv()
+    username = os.getenv("USERNAME")
+    password = os.getenv("PASSWORD")
+
+    # define logger
+    logging.basicConfig(
+        level=logging.ERROR,
+        format="%(asctime)s - %(name)s - %(levelname)s - ID=%(id)s - URL=%(url)s - %(message)s"
+    )
+
+    # define object to be passed onto functions
+    iteration = 1385
+
+    matches = [
+        232434,
+        202485
+    ]
+
+    positions = [
+        "GOALKEEPER",
+        "LEFT_WINGBACK_DEFENDER",
+        "RIGHT_WINGBACK_DEFENDER",
+        "CENTRAL_DEFENDER",
+        "DEFENSE_MIDFIELD",
+        "CENTRAL_MIDFIELD",
+        "ATTACKING_MIDFIELD",
+        "LEFT_WINGER",
+        "RIGHT_WINGER",
+        "CENTER_FORWARD"
+    ]
+
+    # define branches
+    branches = [BRANCH_A_NAME, BRANCH_B_NAME]
+
+    # iterate over envs
+    for branch in branches:
+
+        os.makedirs(f"files/{branch}", exist_ok=True)
+
+        checkout_branch(branch)
+        impectPy = load_impect(branch)
+        print(f"impectPy Version: {impectPy.__version__}")
+
+        config = impectPy.Config()
+        api = impectPy.Impect(config=config)
+        api.login(username, password)
+
+        with tqdm(total=21, desc=f"{branch}: Executing functions...", unit="chunk") as pbar:
+
+            # get iterations
+            iterations = api.getIterations()
+            iterations.to_csv(f"files/{branch}/iterations.csv")
+            pbar.update()
+
+            # get squad ratings
+            ratings = api.getSquadRatings(iteration)
+            ratings.to_csv(f"files/{branch}/ratings.csv")
+            pbar.update()
+
+            # get squad coefficients
+            coefficients = api.getSquadCoefficients(iteration)
+            coefficients.to_csv(f"files/{branch}/coefficients.csv")
+            pbar.update()
+
+            # get matches
+            matchplan = api.getMatches(iteration)
+            matchplan.to_csv(f"files/{branch}/matchplan.csv")
+            pbar.update()
+
+            # get match info
+            formations = api.getFormations(matches)
+            formations.to_csv(f"files/{branch}/formations.csv")
+            pbar.update()
+            substitutions = api.getSubstitutions(matches)
+            substitutions.to_csv(f"files/{branch}/substitutions.csv")
+            pbar.update()
+            startingPositions = api.getStartingPositions(matches)
+            startingPositions.to_csv(f"files/{branch}/startingPositions.csv")
+            pbar.update()
+
+            # get match events
+            events = api.getEvents(matches, include_kpis=True, include_set_pieces=True)
+            events.to_csv(f"files/{branch}/events.csv")
+            pbar.update()
+
+            # get set pieces
+            set_pieces = api.getSetPieces(matches)
+            set_pieces.to_csv(f"files/{branch}/set_pieces.csv")
+            pbar.update()
+
+            # get player iteration averages
+            playerIterationAverages = api.getPlayerIterationAverages(iteration)
+            playerIterationAverages.to_csv(f"files/{branch}/playerIterationAverages.csv")
+            pbar.update()
+
+            # get player matchsums
+            playerMatchsums = api.getPlayerMatchsums(matches)
+            playerMatchsums.to_csv(f"files/{branch}/playerMatchsums.csv")
+            pbar.update()
+
+            # get squad iteration averages
+            squadIterationAverages = api.getSquadIterationAverages(iteration)
+            squadIterationAverages.to_csv(f"files/{branch}/squadIterationAverages.csv")
+            pbar.update()
+
+            # get squad matchsums
+            squadMatchsums = api.getSquadMatchsums(matches)
+            squadMatchsums.to_csv(f"files/{branch}/squadMatchsums.csv")
+            pbar.update()
+
+            # get player match scores
+            playerMatchScores = api.getPlayerMatchScores(matches)
+            playerMatchScores.to_csv(f"files/{branch}/playerMatchScores.csv")
+            pbar.update()
+            playerMatchScores_2 = api.getPlayerMatchScores(matches, positions)
+            playerMatchScores_2.to_csv(f"files/{branch}/playerMatchScores_2.csv")
+            pbar.update()
+
+            # get squad match scores
+            squadMatchScores = api.getSquadMatchScores(matches)
+            squadMatchScores.to_csv(f"files/{branch}/squadMatchScores.csv")
+            pbar.update()
+
+            # get player iteration scores
+            playerIterationScores = api.getPlayerIterationScores(iteration)
+            playerIterationScores.to_csv(f"files/{branch}/playerIterationScores.csv")
+            pbar.update()
+            playerIterationScores_2 = api.getPlayerIterationScores(iteration, positions)
+            playerIterationScores_2.to_csv(f"files/{branch}/playerIterationScores_2.csv")
+            pbar.update()
+
+            # get squad iteration scores
+            squadIterationScores = api.getSquadIterationScores(iteration)
+            squadIterationScores.to_csv(f"files/{branch}/squadIterationScores.csv")
+            pbar.update()
+
+            # get player profile scores
+            playerProfileScores = api.getPlayerProfileScores(iteration, positions)
+            playerProfileScores.to_csv(f"files/{branch}/playerProfileScores.csv")
+            pbar.update()
+
+            # # get data using generic getData() method
+            # pbar.set_description("Get data using generic getData() method...")
+            # data = api.getData(f"https://api.impect.com/v5/customerapi/iterations/{iteration}/players")
+            # pbar.update()
+
+print("\nRunning auto-diff between source and test outputs...\n")
+
+base_path = Path(__file__).parent / "files"
+source_path = base_path / BRANCH_A_NAME
+test_path = base_path / BRANCH_B_NAME
+
+excluded_columns = [
+    # "playerCountry"
+]
+
+failed = False
+assertion_error_patterns = {
+    "column": re.compile(r'column name="([^"]+)"'),
+    "percentage": re.compile(r'values are different \(([\d.]+)\s*%\)'),
+    "first_diff": re.compile(
+        r'At positional index (\d+), first diff:\s*(.*?)\s*!=\s*(.*)'
+    ),
+}
+
+for src_file in source_path.glob("*.csv"):
+    test_file = test_path / src_file.name
+
+    if not test_file.exists():
+        print(f"[MISSING] {src_file.name} not found in test/")
+        failed = True
+        continue
+
+    src_df = pd.read_csv(src_file, low_memory=False)
+    test_df = pd.read_csv(test_file, low_memory=False)
+
+    src_df = src_df[[col for col in src_df.columns if col not in excluded_columns]]
+    test_df = test_df[[col for col in test_df.columns if col not in excluded_columns]]
+
+    try:
+        pd.testing.assert_frame_equal(
+            src_df,
+            test_df,
+            check_dtype=False,
+            check_like=True
+        )
+        print(f"[OK] {src_file.name}")
+    except AssertionError as e:
+        parsed_error = str(e)
+
+        column = assertion_error_patterns["column"].search(parsed_error).group(1)
+        percentage = float(assertion_error_patterns["percentage"].search(parsed_error).group(1))
+
+        first_diff_match = assertion_error_patterns["first_diff"].search(parsed_error)
+        if first_diff_match:
+            first_diff = {
+                "index": int(first_diff_match.group(1)),
+                "left": first_diff_match.group(2),
+                "right": first_diff_match.group(3),
+            }
+        else:
+            # pandas uses [index]/[left]/[right] array format when all values differ
+            idx_match = re.search(r'\[index\]:\s*\[([^]]+)', parsed_error)
+            left_match = re.search(r'\[left\]:\s*\[([^]]+)', parsed_error)
+            right_match = re.search(r'\[right\]:\s*\[([^]]+)', parsed_error)
+            first_diff = {
+                "index": idx_match.group(1).split(",")[0].strip() if idx_match else "?",
+                "left": left_match.group(1).split(",")[0].strip() if left_match else "?",
+                "right": right_match.group(1).split(",")[0].strip() if right_match else "?",
+            }
+
+        result = {
+            "column": column,
+            "percentage_diff": percentage,
+            "first_diff": first_diff,
+        }
+
+        print(f"[DIFF] {src_file.name} : Column '{result['column']}‘ (Delta: {result['percentage_diff']:.2f}%)') : "
+              f"First Diff at index {result['first_diff']['index']} "
+              f"({result['first_diff']['left']} != {result['first_diff']['right']})")
+        failed = True
+
+if failed:
+    raise AssertionError("Auto-diff failed: source and test outputs differ")
+
+print("\nAll source vs test outputs are identical ✅")