ctftime-api 0.1.0__tar.gz → 0.1.1__tar.gz

{ctftime_api-0.1.0 → ctftime_api-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ctftime_api
-Version: 0.1.0
+Version: 0.1.1
 Summary: CTFTime API wrapper
 Keywords: ctftime,api,wrapper
 Author: John Toniutti
@@ -9,6 +9,8 @@ Requires-Python: >=3.11
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Framework :: Pydantic
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{ctftime_api-0.1.0 → ctftime_api-0.1.1}/ctftime_api/client.py

@@ -1,10 +1,11 @@
 from datetime import datetime
 
 import httpx
-from httpx import URL
+from httpx import URL, Timeout
 
 from pydantic_extra_types.country import CountryAlpha2
 
+from ctftime_api.models.vote import Vote
 from ctftime_api.models.event import Event, EventResult
 from ctftime_api.models.team import TeamRank, Team, TeamComplete
 
@@ -176,3 +177,28 @@ class CTFTimeClient:
             int(ctf_id): EventResult(**result, ctf_id=ctf_id)
             for ctf_id, result in event.items()
         }
+
+    async def get_votes_per_year(
+        self, year: int | None, timeout: Timeout | int | float | None = None
+    ) -> list[Vote]:
+        """
+        Get the votes for a specific year.
+        This API call may take a long time to complete.
+        :param year: The year to get the votes for or None for the current year.
+        :param timeout: The timeout for the request.
+            If None, the session timeout will be used.
+        :return: A list of votes.
+        """
+        if year is None:
+            year = datetime.now().year
+
+        if timeout is None:
+            timeout = self._client.timeout
+
+        url = self._base_url.join(f"votes/{year}/")
+        response = await self._client.get(url, timeout=timeout)
+        response.raise_for_status()
+
+        votes = response.json()
+
+        return [Vote(**vote) for vote in votes]

ctftime_api-0.1.1/ctftime_api/models/vote.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+__all__ = ["Vote"]
+
+
+class Vote(BaseModel):
+    event_id: int
+    user_id: int
+    user_teams: list[int]  # list of team IDs
+    weight: str
+    creation_date: datetime

{ctftime_api-0.1.0 → ctftime_api-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ctftime_api"
-version = "0.1.0"
+version = "0.1.1"
 description = "CTFTime API wrapper"
 authors = [
     {name = "John Toniutti",email = "john.toniutti@gmail.com"}
@@ -10,6 +10,8 @@ classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Framework :: Pydantic",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",