skillcorner 2.3.2__tar.gz → 2.3.4__tar.gz

skillcorner-2.3.4/.gitignore

@@ -0,0 +1,54 @@
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+
+.venv
+
+.ruff_cache
+.pytest_cache
+__pycache__
+.coverage
+htmlcov/
+site/
+docs/html/
+docs/doctrees/

skillcorner-2.3.4/.gitlab-ci.yml

@@ -0,0 +1,67 @@
+image: python:3.12-slim
+
+include:
+- project: 'public-corner/skillcorner-CICD'
+  ref: stable
+  file: '.skillcorner-ci-common.yml'
+
+stages:
+  - test
+  - build_and_publish
+  - prepare_release
+  - release
+
+
+ruff:
+  tags: [aws-fargate-runner]
+  extends: .ruff
+
+unit-tests:
+  stage: test
+  tags: [aws-fargate-runner]
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+  variables:
+    UV_PYTHON: ${PYTHON_VERSION}
+  extends: .uv_test_with_coverage
+
+
+package:gitlab:
+  stage: build_and_publish
+  tags: [aws-fargate-runner]
+  extends: .uv_build_and_publish
+
+package:pypi:
+  stage: build_and_publish
+  tags: [aws-fargate-runner]
+  before_script:
+    - !reference [.init_uv]
+  script:
+    - uv build
+    - uvx twine upload dist/*
+  rules:
+    - !reference [.default_release_rules, rules]
+
+
+prepare_job:
+  stage: prepare_release
+  tags: [aws-fargate-runner]
+  extends: .gitlab_release_prepare
+
+release_job:
+  stage: release
+  tags: [aws-fargate-runner]
+  extends: .gitlab_release_job
+
+pages:  # has to be named pages to be deployed in Gitlab Pages
+  stage: release
+  tags: [aws-fargate-runner]
+  script:
+    - mkdir -p public/coverage/
+    - mv htmlcov/* public/coverage/
+  artifacts:
+    paths:
+      - public/coverage/
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

skillcorner-2.3.4/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-toml
+    -   id: check-json
+    -   id: check-yaml
+        args: ['--unsafe']
+    -   id: double-quote-string-fixer
+    -   id: end-of-file-fixer
+    -   id: pretty-format-json
+        args: ['--autofix']
+    -   id: requirements-txt-fixer
+    -   id: sort-simple-yaml
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.4
+    hooks:
+    -   id: ruff
+    -   id: ruff-format
+
+-   repo: https://gitlab.com/vojko.pribudic.foss/pre-commit-update
+    rev: v0.5.0
+    hooks:
+    -   id: pre-commit-update
+
+-   repo: local
+    hooks:
+    -   id: uv-lock
+        description: uv lock file
+        entry: uv run poe lock
+        language: python
+        name: uv lock file
+        pass_filenames: false

skillcorner-2.3.4/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+      post_create_environment:
+        - pip install uv
+      post_install:
+        - uv pip install --upgrade fitrequest sphinx-book-theme
+
+formats:
+   - pdf
+   - epub
+
+sphinx:
+  configuration: docs/source/conf.py

{skillcorner-2.3.2 → skillcorner-2.3.4}/PKG-INFO

@@ -1,20 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: skillcorner
-Version: 2.3.2
+Version: 2.3.4
 Summary: Python client for interact with SkillCorner API
-Home-page: https://skillcorner.com/
-Author: Skillcorner
-Requires-Python: >=3.8,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: fitrequest (>=0.8.0,<0.9.0)
-Requires-Dist: orjson (>=3.9.10,<4.0.0)
-Project-URL: Documentation, https://skillcorner.readthedocs.io/en/latest/
-Project-URL: Repository, https://gitlab.com/public-corner/skillcorner
+License-File: LICENSE.md
+Requires-Python: <3.13,>=3.8
+Requires-Dist: fitrequest>=0.8.2
+Requires-Dist: orjson>=3.9.10
 Description-Content-Type: text/markdown
 
 # Skillcorner
@@ -52,4 +43,3 @@ teams = client.get_teams()
 
 ## Contact
 You can contact Skillcorner Team at: support@skillcorner.com.
-

skillcorner-2.3.4/docs/source/conf.py

@@ -0,0 +1,26 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../../'))
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'skillcorner'
+copyright = '2023, support@skillcorner.com'
+author = 'SkillCorner'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_book_theme'

skillcorner-2.3.4/docs/source/getting_started.rst

@@ -0,0 +1,396 @@
+Getting started
+===============
+
+Installation
+------------
+
+Before using the ``SkillcornerClient``, you need to install it:
+
+.. code-block:: bash
+
+    pip install --upgrade skillcorner
+
+Now you need to set up your Skillcorner credentials by adding the following variables to your environment:
+
+* SKILLCORNER_USERNAME: Your username
+* SKILLCORNER_PASSWORD: Your password
+
+How to use it
+-------------
+
+You can instantiate the ``SkillcornerClient`` class like so:
+
+.. code-block:: python
+
+    from skillcorner.client import SkillcornerClient
+
+    client = SkillcornerClient()
+
+Alternative
+-----------
+
+If you don't want to set those environment variables you will need to provide your username and password at instantiation. We strongly recommend using environment variables or any other way to avoid having your password in your code.
+
+.. code-block:: python
+
+    import os
+    from skillcorner.client import SkillcornerClient
+
+    secret_password = os.getenv('MY_PASSWORD_ENV_VAR')
+    client = SkillcornerClient(username='myusername', password=secret_password)
+
+Examples
+--------
+
+Seasons
+~~~~~~~
+
+Get and print seasons data
+
+.. code-block:: python
+
+    seasons = client.get_seasons()
+    pprint(seasons)
+
+Competitions
+~~~~~~~~~~~~
+
+Get and print competition data for season 2023-2024 (season id 28)
+
+.. code-block:: python
+
+    competitions = client.get_competitions(params={'season': 28})
+    pprint(competitions)
+
+Save competition data to a file
+
+.. code-block:: python
+
+    client.save_competitions(filepath='competitions_23_24.json', params={'season': 28})
+
+Competition editions
+~~~~~~~~~~~~~~~~~~~~
+
+Get and print competition editions for FRA Ligue 1 (competition id 3)
+
+.. code-block:: python
+
+    competition_editions = client.get_competition_editions(competition_id=3)
+    pprint(competition_editions)
+
+Save competition data to a file
+
+.. code-block:: python
+
+    client.save_competition_editions(competition_id=3, filepath='competition_editions_FRA_Ligue_1.json')
+
+We can also filter on the season using the 'params' parameter
+
+.. code-block:: python
+
+    competition_editions = client.get_competition_editions(competition_id=3, params={'season': 28})
+    pprint(competition_editions)
+
+Matches
+~~~~~~~
+
+Get and print matches for FRA Ligue 1 2023-2024 (competition edition id 548)
+
+.. code-block:: python
+
+    matches = client.get_matches(params={'competition_edition': 548})
+    pprint(matches)
+
+Save matches to a file
+
+.. code-block:: python
+
+    client.save_matches(filepath='matches_FRA_Ligue_1_2023_2024.json', params={'competition_edition': 548})
+
+Match data
+~~~~~~~~~~
+
+Get and print match data for FRA Ligue 1 2023-2024 - Clermont Foot vs AS Monaco (match id 1023377)
+
+.. code-block:: python
+
+    match_id = 1023377
+    match_data = client.get_match(match_id=match_id)
+    pprint(match_data)
+
+Save match data to a file
+
+.. code-block:: python
+
+    client.save_match(match_id=match_id, filepath=f'match_data_{match_id}.json')
+
+Match Tracking Data
+~~~~~~~~~~~~~~~~~~~
+
+Get and print match tracking data (if you have access to the match tracking data API)
+
+.. code-block:: python
+
+    match_id = 1023377  # FRA Ligue 1 2023-2024 - Clermont Foot vs AS Monaco
+    match_tracking_data = client.get_match_tracking_data(match_id=match_id)
+    pprint(match_tracking_data[10000:11000])  # print only the tracking data for frames 10000 to 11000
+
+Save match tracking data to a file
+
+.. code-block:: python
+
+    client.save_match_tracking_data(match_id=match_id, filepath=f'match_tracking_data_{match_id}.jsonl')
+
+Physical Data
+~~~~~~~~~~~~~
+
+Get and print physical data for FRA Ligue 1 2023-2024 - OGC Nice (team id 70)
+
+.. code-block:: python
+
+    physical_data = client.get_physical(params={'season': 28, 'team': 70})
+    pprint(physical_data)
+
+Save physical data to a file
+
+.. code-block:: python
+
+    client.save_physical(filepath='physical.json', params={'season': 28, 'team': 70})
+
+In Possession Data
+~~~~~~~~~~~~~~~~~~
+
+Get and print off-ball running data for FRA Ligue 1 2023-2024 (competition edition id 548)
+
+.. code-block:: python
+
+    off_ball_runs = client.get_in_possession_off_ball_runs(params={'competition_edition': 548})
+    pprint(off_ball_runs)
+
+Get and print passing data for FRA Ligue 1 2023-2024 (competition edition id 548)
+
+.. code-block:: python
+
+    passes = client.get_in_possession_passes(params={'competition_edition': 548})
+    pprint(passes)
+
+Get and print overcoming pressure run data for FRA Ligue 1 2023-2024 (competition edition id 548)
+
+.. code-block:: python
+
+    pressure_received = client.get_in_possession_on_ball_pressures(params={'competition_edition': 548})
+    pprint(pressure_received)
+
+Dynamic Events
+~~~~~~~~~~~~~~
+
+Get a bytes array containing off-ball run events for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    import pandas as pd
+
+    from io import BytesIO
+
+    match_id = 1463739
+    off_ball_run_events = client.get_dynamic_events_off_ball_runs(match_id=match_id, params={'file_format':'csv'})
+    df_off_ball_run_events = pd.read_csv(BytesIO(off_ball_run_events))
+
+Get a bytes array containing passing option events for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    import pandas as pd
+
+    from io import BytesIO
+
+    match_id = 1463739
+    passing_options_events = client.get_dynamic_events_passing_options(match_id=match_id, params={'file_format':'csv'})
+    df_passing_options_events = pd.read_csv(BytesIO(passing_options_events))
+
+Get a bytes array containing player possession events for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    from io import BytesIO
+
+    import pandas as pd
+
+    match_id = 1463739
+    player_possessions_events = client.get_dynamic_events_player_possessions(match_id=match_id, params={'file_format':'csv'})
+    df_player_possessions_events = pd.read_csv(BytesIO(player_possessions_events))
+
+Get a bytes array containing combined off-ball run, passing option and player possession events for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    import pandas as pd
+
+    from io import BytesIO
+
+    match_id = 1463739
+    combined_dynamic_events = client.get_dynamic_events(match_id=match_id, params={'file_format':'csv'})
+    df_combined_dynamic_events = pd.read_csv(BytesIO(combined_dynamic_events))
+
+Save an off-ball run events CSV file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_off_ball_runs(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.csv',
+                                             params={'file_format':'csv'})
+
+Save a passing option events CSV file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_passing_options(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.csv',
+                                             params={'file_format':'csv'})
+
+
+Save a player possession events CSV file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_player_possessions(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.csv',
+                                             params={'file_format':'csv'})
+
+Save a combined off-ball run, passing option and player possession events CSV file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.csv',
+                                             params={'file_format':'csv'})
+
+Save an off-ball run events Sportscode XML file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_off_ball_runs(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.xml',
+                                             params={'file_format':'sportscode-xml'})
+
+Save a passing option events Sportscode XML file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_passing_options(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.xml',
+                                             params={'file_format':'sportscode-xml'})
+
+Save a player possession events Sportscode XML file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_player_possessions(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.xml',
+                                             params={'file_format':'sportscode-xml'})
+
+Save a combined off-ball run, passing option and player possession events Sportscode XML file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.xml',
+                                             params={'file_format':'sportscode-xml'})
+
+Save an off-ball run events Focus JSON file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_off_ball_runs(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.json',
+                                             params={'file_format':'focus-json'})
+
+Save a passing option events Focus JSON file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_passing_options(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.json',
+                                             params={'file_format':'focus-json'})
+
+Save a player possession events Focus JSON file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events_player_possessions(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.json',
+                                             params={'file_format':'focus-json'})
+
+Save a combined off-ball run, passing option and player possession Focus JSON file for 2024-03-31 Manchester City Vs Arsenal match (match id 1463739)
+
+.. code-block:: python
+
+    match_id = 1463739
+    client.save_dynamic_events(match_id=match_id,
+                                             filepath=f'{match_id}_off_ball_runs.json',
+                                             params={'file_format':'focus-json'})
+
+Teams
+~~~~~
+
+Get and print teams for FRA Ligue 1 2023-2024 (competition edition id 548)
+
+.. code-block:: python
+
+    teams = client.get_teams(params={'competition_edition': 548})
+    pprint(teams)
+
+Save team data
+
+.. code-block:: python
+
+    client.save_teams(filepath='teams_FRA_Ligue_1_2023_2024.json', params={'competition_edition': 548})
+
+Get and print team data for OGC Nice (team id 70)
+
+.. code-block:: python
+
+    team_id = 70
+    team_data = client.get_team(team_id=team_id)
+    pprint(team_data)
+
+Save team data
+
+.. code-block:: python
+
+    client.save_team(team_id=team_id, filepath=f'team_{team_id}.json')
+
+Players
+~~~~~~~
+
+Get and print players
+
+.. code-block:: python
+
+    players = client.get_players(params={'search': 'barcola'})
+    pprint(players)
+
+Get and print player data
+
+.. code-block:: python
+
+    player_id = 68485
+    player_data = client.get_player(player_id=player_id)
+    pprint(player_data)
+
+Save player data
+
+.. code-block:: python
+
+    client.save_player(player_id=player_id, filepath=f'player_{player_id}.json')

skillcorner-2.3.4/docs/source/index.rst

@@ -0,0 +1,23 @@
+Welcome to SkillCorner's Python SDK Documentation
+=================================================
+
+Useful Links
+------------
+
+* **Code**: `skillcorner GitLab <https://gitlab.com/public-corner/skillcorner/>`_
+* **Pypi**: `skillcorner PyPI <https://pypi.org/project/skillcorner/>`_
+* **SwaggerUI API Documentation**: `REST API Docs <https://www.skillcorner.com/api/docs>`_
+
+Overview
+--------
+
+The ``SkillcornerClient`` is a Python class designed to interact with the Skillcorner API. It provides methods to retrieve and save various data related to competitions, seasons, matches, teams, and players.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+   skillcorner_client

skillcorner-2.3.4/docs/source/skillcorner_client.rst

@@ -0,0 +1,6 @@
+SkillcornerClient
+=================
+
+.. autoclass:: skillcorner.client.SkillcornerClient
+   :members:
+   :show-inheritance: