opengamedata-api-files 2.0.0__tar.gz

opengamedata_api_files-2.0.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.1
+Name: opengamedata-api-files
+Version: 2.0.0
+Summary: A small collection of classes for deserializing data from the OpenGameData File API.
+Author: Ryan Wilkinson
+Author-email: Luke Swanson <lwswanson2@wisc.edu>, David Gagnon <djgagnon@wisc.edu>
+Project-URL: Homepage, https://github.com/opengamedata/opengamedata-api-files
+Project-URL: Bug Tracker, https://github.com/opengamedata/opengamedata-api-files/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: opengamedata-common==2.0.*
+Requires-Dist: opengamedata-api-utils==1.5.*

opengamedata_api_files-2.0.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = [
+    "build == 1.2.*",
+    "setuptools == 74.1.*",
+    "setuptools-git-versioning == 2.0.*",
+    "twine == 5.1.*",
+    "wheel == 0.44.*"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["ogd.apis.models.files"]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[project]
+name = "opengamedata-api-files"
+dynamic = ["version", "dependencies"]
+authors = [
+   { name="Luke Swanson", email="lwswanson2@wisc.edu" },
+   { name="David Gagnon", email="djgagnon@wisc.edu" },
+   { name="Ryan Wilkinson" }
+]
+description = "A small collection of classes for deserializing data from the OpenGameData File API."
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/opengamedata/opengamedata-api-files"
+"Bug Tracker" = "https://github.com/opengamedata/opengamedata-api-files/issues"

opengamedata_api_files-2.0.0/requirements.txt

@@ -0,0 +1,2 @@
+opengamedata-common==2.0.*
+opengamedata-api-utils==1.5.*

opengamedata_api_files-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

opengamedata_api_files-2.0.0/src/ogd/apis/models/files/Dataset.py

@@ -0,0 +1,71 @@
+from typing import Final, List
+
+from ogd.apis.models.APIResponse import APIResponse
+from ogd.common.utils.typing import Map
+
+class Dataset:
+    PATH : Final[str] = "/games/<string:game_id>/datasets/<int:year>"
+
+    def __init__(self, year:int,    month:int,        total_sessions:int,
+                 sessions_file:str, players_file:str, population_file:str):
+        self._year            = year
+        self._month           = month
+        self._total_sessions  = total_sessions
+        self._sessions_file   = sessions_file
+        self._players_file    = players_file
+        self._population_file = population_file
+
+    @property
+    def Year(self) -> int:
+        return self._year
+    @property
+    def Month(self) -> int:
+        return self._month
+    @property
+    def TotalSessions(self) -> int:
+        return self._total_sessions
+    @property
+    def SessionsFile(self) -> str:
+        return self._sessions_file
+    @property
+    def PlayersFile(self) -> str:
+        return self._players_file
+    @property
+    def PopulationFile(self) -> str:
+        return self._population_file
+
+    @property
+    def AsDict(self) -> Map:
+        return {
+            "year": self.Year,
+            "month": self.Month,
+            "total_sessions": self.TotalSessions,
+            "sessions_file": self.SessionsFile,
+            "players_file": self.PlayersFile,
+            "population_file": self.PopulationFile
+        }
+    
+    @staticmethod
+    def FromAPIResponse(response:APIResponse) -> "Dataset":
+        """Parse a GameSummary from an APIResponse
+
+        :param response: The APIResponse object containing the GameSummary data.
+        :type response: APIResponse
+        :return: A GameSummary object constructed from the data given in the APIResponse
+        :rtype: GameSummary
+        """
+        ret_val : Dataset
+
+        if isinstance(response.Value, dict):
+            if all(key in response.Value.keys() for key in {"year", "month", "total_sessions", "sessions_file", "players_file", "population_file"}):
+                ret_val = Dataset(
+                    year=response.Value.get("year", 0),
+                    month=response.Value.get("month", 0),
+                    total_sessions=response.Value.get("total_sessions", 0),
+                    sessions_file=response.Value.get("sessions_file", "SESSIONS FILE NOT FOUND"),
+                    players_file=response.Value.get("players_file", "PLAYERS FILE NOT FOUND"),
+                    population_file=response.Value.get("population_file", "POPULATION FILE NOT FOUND"),
+                )
+            else:
+                raise ValueError(f"APIResponse for DatasetsYear had incorrect keys.")
+        return ret_val

opengamedata_api_files-2.0.0/src/ogd/apis/models/files/DatasetFile.py

@@ -0,0 +1,46 @@
+from typing import Final, List
+
+from ogd.apis.models.APIResponse import APIResponse
+from ogd.common.utils.typing import Map
+
+class DatasetFile:
+    PATH : Final[str] = "/games/<string:game_id>/datasets/<int:year>"
+
+    def __init__(self, columns:List,    rows:List):
+        self._columns = columns
+        self._rows    = rows
+
+    @property
+    def Columns(self) -> List:
+        return self._columns
+    @property
+    def Rows(self) -> List:
+        return self._rows
+
+    @property
+    def AsDict(self) -> Map:
+        return {
+            "columns": self.Columns,
+            "rows": self.Rows
+        }
+    
+    @staticmethod
+    def FromAPIResponse(response:APIResponse) -> "DatasetFile":
+        """Parse a GameSummary from an APIResponse
+
+        :param response: The APIResponse object containing the GameSummary data.
+        :type response: APIResponse
+        :return: A GameSummary object constructed from the data given in the APIResponse
+        :rtype: GameSummary
+        """
+        ret_val : DatasetFile
+
+        if isinstance(response.Value, dict):
+            if all(key in response.Value.keys() for key in {"columns", "rows"}):
+                ret_val = DatasetFile(
+                    columns=response.Value.get("columns", ["NO COLUMNS FOUND"]),
+                    rows=response.Value.get("rows", ["NO ROWS FOUND"]),
+                )
+            else:
+                raise ValueError(f"APIResponse for DatasetFile had incorrect keys.")
+        return ret_val

opengamedata_api_files-2.0.0/src/ogd/apis/models/files/DatasetInfo.py

@@ -0,0 +1,165 @@
+from typing import Final, Optional
+
+from ogd.apis.models.APIResponse import APIResponse
+from ogd.common.schemas.datasets.DatasetSchema import DatasetSchema
+from ogd.common.utils.typing import Map
+
+class DatasetInfo:
+    PATH : Final[str] = "/games/<string:game_id>/datasets/<int:year>"
+
+    def __init__(self, first_year:int, first_month:int, last_year:int,     last_month:int,
+                       raw_file:Optional[str],   events_file:Optional[str], sessions_file:Optional[str], players_file:Optional[str], population_file:Optional[str],
+                       events_template:Optional[str],  sessions_template:Optional[str],  players_template:Optional[str],  population_template:Optional[str],
+                       events_codespace:Optional[str], sessions_codespace:Optional[str], players_codespace:Optional[str], population_codespace:Optional[str],
+                       detectors_link:Optional[str],   features_link:Optional[str],      found_matching_range:bool):
+        self._first_year      = first_year
+        self._first_month     = first_month
+        self._last_year       = last_year
+        self._last_month      = last_month
+        self._raw_file        = raw_file
+        self._events_file     = events_file
+        self._sessions_file   = sessions_file
+        self._players_file    = players_file
+        self._population_file = population_file
+        self._events_template      = events_template
+        self._sessions_template    = sessions_template
+        self._players_template     = players_template
+        self._population_template  = population_template
+        self._events_codespace     = events_codespace
+        self._sessions_codespace   = sessions_codespace
+        self._players_codespace    = players_codespace
+        self._population_codespace = population_codespace
+        self._detectors_link       = detectors_link
+        self._features_link        = features_link
+        self._found_matching_range = found_matching_range
+
+    @property
+    def FirstYear(self) -> int:
+        return self._first_year
+    @property
+    def FirstMonth(self) -> int:
+        return self._first_month
+    @property
+    def LastYear(self) -> int:
+        return self._last_year
+    @property
+    def LastMonth(self) -> int:
+        return self._last_month
+    @property
+    def RawFile(self) -> Optional[str]:
+        return self._raw_file
+    @property
+    def EventsFile(self) -> Optional[str]:
+        return self._events_file
+    @property
+    def SessionsFile(self) -> Optional[str]:
+        return self._sessions_file
+    @property
+    def PlayersFile(self) -> Optional[str]:
+        return self._players_file
+    @property
+    def PopulationFile(self) -> Optional[str]:
+        return self._population_file
+    @property
+    def EventsTemplate(self) -> Optional[str]:
+        return self._events_template
+    @property
+    def SessionsTemplate(self) -> Optional[str]:
+        return self._sessions_template
+    @property
+    def PlayersTemplate(self) -> Optional[str]:
+        return self._players_template
+    @property
+    def PopulationTemplate(self) -> Optional[str]:
+        return self._population_template
+    @property
+    def EventsCodespace(self) -> Optional[str]:
+        return self._events_codespace
+    @property
+    def SessionsCodespace(self) -> Optional[str]:
+        return self._sessions_codespace
+    @property
+    def PlayersCodespace(self) -> Optional[str]:
+        return self._players_codespace
+    @property
+    def PopulationCodespace(self) -> Optional[str]:
+        return self._population_codespace
+    @property
+    def DetectorsLink(self) -> Optional[str]:
+        return self._detectors_link
+    @property
+    def FeaturesLink(self) -> Optional[str]:
+        return self._features_link
+
+    @property
+    def AsDict(self) -> Map:
+        return {
+            "first_year": self.FirstYear,
+            "first_month": self.FirstMonth,
+            "last_year": self.LastYear,
+            "last_month": self.LastMonth,
+            "raw_file": self.RawFile,
+            "events_file": self.EventsFile,
+            "sessions_file": self.SessionsFile,
+            "players_file": self.PlayersFile,
+            "population_file": self.PopulationFile,
+            "events_template": self.EventsTemplate,
+            "sessions_template": self.SessionsTemplate,
+            "players_template": self.PlayersTemplate,
+            "population_template": self.PopulationTemplate,
+            "events_codespace": self.EventsCodespace,
+            "sessions_codespace": self.SessionsCodespace,
+            "players_codespace": self.PlayersCodespace,
+            "population_codespace": self.PopulationCodespace,
+            "detectors_link": self.DetectorsLink,
+            "features_link": self.FeaturesLink,
+            "found_matching_range": self._found_matching_range
+        }
+
+            
+    
+    @staticmethod
+    def FromAPIResponse(response:APIResponse) -> "DatasetInfo":
+        """Parse a GameSummary from an APIResponse
+
+        :param response: The APIResponse object containing the GameSummary data.
+        :type response: APIResponse
+        :return: A GameSummary object constructed from the data given in the APIResponse
+        :rtype: GameSummary
+        """
+        ret_val : DatasetInfo
+
+        if isinstance(response.Value, dict):
+            expected_keys = {
+                "first_year", "first_month", "last_year", "last_month",
+                "raw_file", "events_file", "sessions_file", "players_file", "population_file",
+                "events_template", "sessions_template", "players_template", "population_template",
+                "events_codespace", "sessions_codespace", "players_codespace", "population_codespace",
+                "detectors_link", "features_link", "found_matching_range"
+            }
+            if all(key in response.Value.keys() for key in expected_keys):
+                ret_val = DatasetInfo(
+                    first_year=response.Value.get("first_year", 0),
+                    first_month=response.Value.get("first_month", 0),
+                    last_year=response.Value.get("last_year", 0),
+                    last_month=response.Value.get("last_month", 0),
+                    raw_file=response.Value.get("raw_file"),
+                    events_file=response.Value.get("events_file"),
+                    sessions_file=response.Value.get("sessions_file"),
+                    players_file=response.Value.get("players_file"),
+                    population_file=response.Value.get("population_file"),
+                    events_template=response.Value.get("events_template"),
+                    sessions_template=response.Value.get("sessions_template"),
+                    players_template=response.Value.get("players_template"),
+                    population_template=response.Value.get("population_template"),
+                    events_codespace=response.Value.get("events_codespace"),
+                    sessions_codespace=response.Value.get("sessions_codespace"),
+                    players_codespace=response.Value.get("players_codespace"),
+                    population_codespace=response.Value.get("population_codespace"),
+                    detectors_link=response.Value.get("detectors_link"),
+                    features_link=response.Value.get("features_link"),
+                    found_matching_range=response.Value.get("found_matching_range", False)
+                )
+            else:
+                raise ValueError(f"APIResponse for DatasetInfo had incorrect keys.")
+        return ret_val

opengamedata_api_files-2.0.0/src/ogd/apis/models/files/GameList.py

@@ -0,0 +1,40 @@
+from typing import Final, List
+
+from ogd.apis.models.APIResponse import APIResponse
+from ogd.common.utils.typing import Map
+
+class GameList:
+    PATH : Final[str] = "/games"
+
+    def __init__(self, game_ids:List[str]):
+        self._game_ids = game_ids
+
+    @property
+    def GameIDs(self) -> List[str]:
+        return self._game_ids
+
+    @property
+    def AsDict(self) -> Map:
+        return {
+            "game_ids": self.GameIDs
+        }
+    
+    @staticmethod
+    def FromAPIResponse(response:APIResponse) -> "GameList":
+        """Parse a GameSummary from an APIResponse
+
+        :param response: The APIResponse object containing the GameSummary data.
+        :type response: APIResponse
+        :return: A GameSummary object constructed from the data given in the APIResponse
+        :rtype: GameSummary
+        """
+        ret_val : GameList
+
+        if isinstance(response.Value, dict):
+            if all(key in response.Value.keys() for key in {"game_ids"}):
+                ret_val = GameList(
+                    game_ids=response.Value.get("game_ids", "GAMES NOT FOUND"),
+                )
+            else:
+                raise ValueError(f"APIResponse for GamesList had incorrect keys.")
+        return ret_val

opengamedata_api_files-2.0.0/src/ogd/apis/models/files/GameSummary.py

@@ -0,0 +1,57 @@
+from typing import Final, Optional
+from ogd.apis.models.APIResponse import APIResponse
+from ogd.common.utils.typing import Map
+
+class GameSummary:
+    PATH : Final[str] = "/games/<string:game_id>"
+
+    def __init__(self, game_id:str, dataset_count:int, session_avg:Optional[int], initial_dataset:str):
+        self._game_id = game_id
+        self._dataset_count = dataset_count
+        self._session_avg   = session_avg
+        self._initial_dataset = initial_dataset
+
+    @property
+    def GameID(self) -> str:
+        return self._game_id
+    @property
+    def DatasetCount(self) -> int:
+        return self._dataset_count
+    @property
+    def SessionAverage(self) -> Optional[int]:
+        return self._session_avg
+    @property
+    def InitialDataset(self) -> str:
+        return self._initial_dataset
+
+    @property
+    def AsDict(self) -> Map:
+        return {
+            "game_id": self.GameID,
+            "dataset_count": self.DatasetCount,
+            "session_average": self.SessionAverage,
+            "initial_dataset": self.InitialDataset
+        }
+    
+    @staticmethod
+    def FromAPIResponse(response:APIResponse) -> "GameSummary":
+        """Parse a GameSummary from an APIResponse
+
+        :param response: The APIResponse object containing the GameSummary data.
+        :type response: APIResponse
+        :return: A GameSummary object constructed from the data given in the APIResponse
+        :rtype: GameSummary
+        """
+        ret_val : GameSummary
+
+        if isinstance(response.Value, dict):
+            if all(key in response.Value.keys() for key in {"game_id", "dataset_count", "session_average", "initial_dataset"}):
+                ret_val = GameSummary(
+                    game_id=response.Value.get("game_id", "GAME NOT FOUND"),
+                    dataset_count=response.Value.get("dataset_count", 0),
+                    session_avg=response.Value.get("session_average", None),
+                    initial_dataset=response.Value.get("initial_dataset", "DATASET NOT FOUND")
+                )
+            else:
+                raise ValueError(f"APIResponse for GameSummary had incorrect keys.")
+        return ret_val

opengamedata_api_files-2.0.0/src/opengamedata_api_files.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.1
+Name: opengamedata-api-files
+Version: 2.0.0
+Summary: A small collection of classes for deserializing data from the OpenGameData File API.
+Author: Ryan Wilkinson
+Author-email: Luke Swanson <lwswanson2@wisc.edu>, David Gagnon <djgagnon@wisc.edu>
+Project-URL: Homepage, https://github.com/opengamedata/opengamedata-api-files
+Project-URL: Bug Tracker, https://github.com/opengamedata/opengamedata-api-files/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: opengamedata-common==2.0.*
+Requires-Dist: opengamedata-api-utils==1.5.*

opengamedata_api_files-2.0.0/src/opengamedata_api_files.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+pyproject.toml
+requirements.txt
+src/ogd/apis/models/files/Dataset.py
+src/ogd/apis/models/files/DatasetFile.py
+src/ogd/apis/models/files/DatasetInfo.py
+src/ogd/apis/models/files/GameList.py
+src/ogd/apis/models/files/GameSummary.py
+src/ogd/apis/models/files/__init__.py
+src/opengamedata_api_files.egg-info/PKG-INFO
+src/opengamedata_api_files.egg-info/SOURCES.txt
+src/opengamedata_api_files.egg-info/dependency_links.txt
+src/opengamedata_api_files.egg-info/requires.txt
+src/opengamedata_api_files.egg-info/top_level.txt

opengamedata_api_files-2.0.0/src/opengamedata_api_files.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

opengamedata_api_files-2.0.0/src/opengamedata_api_files.egg-info/requires.txt

@@ -0,0 +1,2 @@
+opengamedata-common==2.0.*
+opengamedata-api-utils==1.5.*

opengamedata_api_files-2.0.0/src/opengamedata_api_files.egg-info/top_level.txt

@@ -0,0 +1 @@
+ogd