added templates and made everything accept Client rather than only AuthenticatedClient

Author: arihant2math

CHANGELOG.md

@@ -1,7 +1,12 @@
-# 0.0.2
-* Fixed numbering in pyproject.toml
-# 0.0.1
-* Changed default prefix of Authorization header to "Basic", which should be the default for the API
-* Fixed bug that caused double //s when requesting a api endpoint.
 # 0.0.0
-* Initial Release
+* Initial Release
+### 0.0.1
+* Changed default prefix of Authorization header to "Basic", which should be the default for the API
+* Fixed bug that caused double //s when requesting an api endpoint.
+### 0.0.2
+* Fixed numbering in pyproject.toml
+## 0.1.0
+* Merged `Client` with `AuthenticatedClient` using `AuthenticatedClient` is now deprecated
+* Added support for creating a Client with a username and access key
+* Removed `attrs` as a dependency
+* Added support for [ftcstats](https://ftcstats.org)

custom_templates/client.py.jinja

@@ -0,0 +1,40 @@
+import base64
+import ssl
+from typing import Dict, Union
+
+
+class Client:
+    """A class for keeping track of data related to the API"""
+
+    cookies = {}
+    headers: Dict[str, str] = {}
+    timeout: float = 5.0
+    verify_ssl: Union[str, bool, ssl.SSLContext] = True
+    raise_on_unexpected_status: bool = False
+    prefix: str = "Basic"
+    auth_header_name: str = "Authorization"
+
+    def __init__(self, token=None, username="", authorization_key=""):
+        if token is not None:
+            self.token = token
+        else:
+            token = username + ":" + authorization_key
+            token_bytes = token.encode("ascii")
+            base64_bytes = base64.b64encode(token_bytes)
+            self.token = base64_bytes.decode("ascii")
+
+    def get_headers(self) -> Dict[str, str]:
+        auth_header_value = f"{self.prefix} {self.token}" if self.prefix else self.token
+        """Get headers to be used in authenticated endpoints"""
+        return {self.auth_header_name: auth_header_value, **self.headers}
+
+    def get_cookies(self) -> Dict[str, str]:
+        return {**self.cookies}
+
+    def get_timeout(self) -> float:
+        return self.timeout
+
+
+class AuthenticatedClient(Client):
+    """Deprecated, use Client instead, as it has equivalent functionality, will be removed v1.0.0"""
+    pass

custom_templates/package_init.py.jinja

@@ -0,0 +1,7 @@
+""" A client library for accessing FTC Events API """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client"
+)

custom_templates/pyproject.toml.jinja

@@ -0,0 +1,26 @@
+[project]
+name = "ftc_api"
+description = "A python client to access the FIRST Tech Challenge API"
+authors = [
+    {name = "Ashwin Naren", email="arihant2math@gmail.com"}
+]
+license = {file = "LICENSE"}
+readme = "README.md"
+version = "0.1.0"
+dependencies = [
+    "httpx", "python-dateutil"
+]
+keywords = ["ftc"]
+requires-python = ">=3.7"
+
+[project.optional-dependencies]
+dev = [
+    "black"
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["ftc_api"]

ftc_api/api/alliance_selection/get_v_2_0_season_alliances_event_code.py

@@ -4,7 +4,7 @@
 import httpx
 
 from ... import errors
-from ...client import AuthenticatedClient, Client
+from ...client import Client
 from ...models.alliance_selection import AllianceSelection
 from ...types import Response
 
@@ -13,7 +13,7 @@ def _get_kwargs(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Dict[str, Any]:
     url = "{}/v2.0/{season}/alliances/{eventCode}".format("https://ftc-api.firstinspires.org", season=season, eventCode=event_code)
 
@@ -56,7 +56,7 @@ def sync_detailed(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[AllianceSelection, Any]]:
     """Event Alliances
 
@@ -93,7 +93,7 @@ def sync(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[AllianceSelection, Any]]:
     """Event Alliances
 
@@ -123,7 +123,7 @@ async def asyncio_detailed(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[AllianceSelection, Any]]:
     """Event Alliances
 
@@ -158,7 +158,7 @@ async def asyncio(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[AllianceSelection, Any]]:
     """Event Alliances
 

ftc_api/api/alliance_selection/get_v_2_0_season_alliances_event_code_selection.py

@@ -4,7 +4,7 @@
 import httpx
 
 from ... import errors
-from ...client import AuthenticatedClient, Client
+from ...client import Client
 from ...models.alliance_selection_details import AllianceSelectionDetails
 from ...types import Response
 
@@ -13,7 +13,7 @@ def _get_kwargs(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Dict[str, Any]:
     url = "{}/v2.0/{season}/alliances/{eventCode}/selection".format(
         "https://ftc-api.firstinspires.org", season=season, eventCode=event_code
@@ -58,7 +58,7 @@ def sync_detailed(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[AllianceSelectionDetails, Any]]:
     """Alliance Selection Details
 
@@ -95,7 +95,7 @@ def sync(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[AllianceSelectionDetails, Any]]:
     """Alliance Selection Details
 
@@ -125,7 +125,7 @@ async def asyncio_detailed(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[AllianceSelectionDetails, Any]]:
     """Alliance Selection Details
 
@@ -160,7 +160,7 @@ async def asyncio(
     season: int,
     event_code: Optional[str],
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[AllianceSelectionDetails, Any]]:
     """Alliance Selection Details
 

ftc_api/api/awards/get_v2_0_season_awards_list.py

@@ -4,15 +4,15 @@
 import httpx
 
 from ... import errors
-from ...client import AuthenticatedClient, Client
+from ...client import Client
 from ...models.award_list import AwardList
 from ...types import Response
 
 
 def _get_kwargs(
     season: int,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Dict[str, Any]:
     url = "{}/v2.0/{season}/awards/list".format("https://ftc-api.firstinspires.org", season=season)
 
@@ -54,7 +54,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Uni
 def sync_detailed(
     season: int,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[Any, AwardList]]:
     """Award Listings
 
@@ -90,7 +90,7 @@ def sync_detailed(
 def sync(
     season: int,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[Any, AwardList]]:
     """Award Listings
 
@@ -119,7 +119,7 @@ def sync(
 async def asyncio_detailed(
     season: int,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[Any, AwardList]]:
     """Award Listings
 
@@ -153,7 +153,7 @@ async def asyncio_detailed(
 async def asyncio(
     season: int,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[Any, AwardList]]:
     """Award Listings
 

ftc_api/api/awards/get_v_2_0_season_awards_event_code.py

@@ -4,7 +4,7 @@
 import httpx
 
 from ... import errors
-from ...client import AuthenticatedClient, Client
+from ...client import Client
 from ...models.award_assignment_list import AwardAssignmentList
 from ...types import UNSET, Response, Unset
 
@@ -13,7 +13,7 @@ def _get_kwargs(
     season: int,
     event_code: Optional[str] = "",
     *,
-    client: AuthenticatedClient,
+    client: Client,
     team_number: Union[Unset, None, int] = 0,
 ) -> Dict[str, Any]:
     url = "{}/v2.0/{season}/awards/{eventCode}".format("https://ftc-api.firstinspires.org", season=season, eventCode=event_code)
@@ -63,7 +63,7 @@ def sync_detailed(
     season: int,
     event_code: Optional[str] = "",
     *,
-    client: AuthenticatedClient,
+    client: Client,
     team_number: Union[Unset, None, int] = 0,
 ) -> Response[Union[Any, AwardAssignmentList]]:
     """Event Awards
@@ -109,7 +109,7 @@ def sync(
     season: int,
     event_code: Optional[str] = "",
     *,
-    client: AuthenticatedClient,
+    client: Client,
     team_number: Union[Unset, None, int] = 0,
 ) -> Optional[Union[Any, AwardAssignmentList]]:
     """Event Awards
@@ -148,7 +148,7 @@ async def asyncio_detailed(
     season: int,
     event_code: Optional[str] = "",
     *,
-    client: AuthenticatedClient,
+    client: Client,
     team_number: Union[Unset, None, int] = 0,
 ) -> Response[Union[Any, AwardAssignmentList]]:
     """Event Awards
@@ -192,7 +192,7 @@ async def asyncio(
     season: int,
     event_code: Optional[str] = "",
     *,
-    client: AuthenticatedClient,
+    client: Client,
     team_number: Union[Unset, None, int] = 0,
 ) -> Optional[Union[Any, AwardAssignmentList]]:
     """Event Awards

ftc_api/api/awards/get_v_2_0_season_awards_event_code_team_number.py

@@ -4,7 +4,7 @@
 import httpx
 
 from ... import errors
-from ...client import AuthenticatedClient, Client
+from ...client import Client
 from ...models.award_assignment_list import AwardAssignmentList
 from ...types import Response
 
@@ -14,7 +14,7 @@ def _get_kwargs(
     event_code: Optional[str] = "",
     team_number: int = 0,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Dict[str, Any]:
     url = "{}/v2.0/{season}/awards/{eventCode}/{teamNumber}".format(
         "https://ftc-api.firstinspires.org", season=season, eventCode=event_code, teamNumber=team_number
@@ -60,7 +60,7 @@ def sync_detailed(
     event_code: Optional[str] = "",
     team_number: int = 0,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[Any, AwardAssignmentList]]:
     """Event Awards
 
@@ -106,7 +106,7 @@ def sync(
     event_code: Optional[str] = "",
     team_number: int = 0,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[Any, AwardAssignmentList]]:
     """Event Awards
 
@@ -145,7 +145,7 @@ async def asyncio_detailed(
     event_code: Optional[str] = "",
     team_number: int = 0,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Response[Union[Any, AwardAssignmentList]]:
     """Event Awards
 
@@ -189,7 +189,7 @@ async def asyncio(
     event_code: Optional[str] = "",
     team_number: int = 0,
     *,
-    client: AuthenticatedClient,
+    client: Client,
 ) -> Optional[Union[Any, AwardAssignmentList]]:
     """Event Awards