chore(types): clean types annotations

JD · JD · commit 897448f01a64 · 2025-11-07T09:20:35.000+01:00
diff --git a/.env.example b/.env.example
@@ -0,0 +1 @@
+CS_TOKEN="secret_token"
diff --git a/.gitignore b/.gitignore
@@ -16,5 +16,6 @@ wheels/
 .venv/
 venv/
 env/
+*.env
 
 .pytest_cache
diff --git a/Makefile b/Makefile
@@ -12,7 +12,7 @@ install: ## Sets up the development environment
 	@echo "2. Installing all dependencies (including 'dev')..."
 	uv pip install -e '.[dev]'
 	@echo "3. Installing git hooks with pre-commit..."
-	pre-commit install --hook-type commit-msg --hook-type pre-commit --hook-type pre-push
+	uv run pre-commit install --hook-type commit-msg --hook-type pre-commit --hook-type pre-push
 	@echo "\n\033[0;32mSetup complete! Please activate the virtual environment with 'source .venv/bin/activate'.\033[0m"
 
 commit: ## Starts Commitizen for a guided commit message
diff --git a/examples/metadata/get_datacenters.py b/examples/metadata/get_datacenters.py
@@ -1,18 +1,14 @@
 import asyncio
-import pprint
 from codesphere import CodesphereSDK
 
 
 async def main():
     """Fetches datacenters."""
     async with CodesphereSDK() as sdk:
         datacenters = await sdk.metadata.datacenters()
-
         for datacenter in datacenters:
-            pprint.pprint(datacenter.name)
-            pprint.pprint(datacenter.city)
-            pprint.pprint(datacenter.countryCode)
-            pprint.pprint(datacenter.id)
+            print(datacenter.model_dump_json(indent=2))
+
 
 if __name__ == "__main__":
     asyncio.run(main())
diff --git a/examples/metadata/get_workspace_base_image.py b/examples/metadata/get_workspace_base_image.py
@@ -1,17 +1,14 @@
 import asyncio
-import pprint
 from codesphere import CodesphereSDK
 
 
 async def main():
     """Fetches base images."""
     async with CodesphereSDK() as sdk:
         images = await sdk.metadata.images()
-
         for image in images:
-            pprint.pprint(image.id)
-            pprint.pprint(image.name)
-            pprint.pprint(image.supportedUntil)
+            print(image.model_dump_json(indent=2))
+
 
 if __name__ == "__main__":
     asyncio.run(main())
diff --git a/examples/metadata/get_workspace_plans.py b/examples/metadata/get_workspace_plans.py
@@ -1,5 +1,4 @@
 import asyncio
-import pprint
 from codesphere import CodesphereSDK
 
 
@@ -9,18 +8,8 @@ async def main():
         plans = await sdk.metadata.plans()
 
         for plan in plans:
-            pprint.pprint(plan.id)
-            pprint.pprint(plan.title)
-            pprint.pprint(plan.priceUsd)
-            pprint.pprint(plan.deprecated)
-            pprint.pprint(plan.characteristics.id)
-            pprint.pprint(plan.characteristics.CPU)
-            pprint.pprint(plan.characteristics.GPU)
-            pprint.pprint(plan.characteristics.RAM)
-            pprint.pprint(plan.characteristics.SSD)
-            pprint.pprint(plan.characteristics.TempStorage)
-            pprint.pprint(plan.characteristics.onDemand)
-            pprint.pprint(plan.maxReplicas)     
+            print(plan.model_dump_json(indent=2))
+
 
 if __name__ == "__main__":
     asyncio.run(main())
diff --git a/examples/teams/create_team.py b/examples/teams/create_team.py
@@ -1,18 +1,14 @@
 import asyncio
-import pprint
-
-from codesphere import CodesphereSDK
+from codesphere import CodesphereSDK, TeamCreate
 
 
 async def main():
     try:
         async with CodesphereSDK() as sdk:
-            created_team = await sdk.teams.create(name="hello", dc=2)
+            newTeam = TeamCreate(name="test", dc=2)
+            created_team = await sdk.teams.create(data=newTeam)
             print("\n--- Details for the created team ---")
-            pprint.pprint(created_team.model_dump())
-
-            print(f"Team ID: {created_team.id}, Name: {created_team.name}")
-
+            print(created_team.model_dump_json(indent=2))
     except Exception as e:
         print(f"An error occurred: {e}")
 
diff --git a/examples/teams/delete_team.py b/examples/teams/delete_team.py
@@ -1,6 +1,4 @@
 import asyncio
-import pprint
-
 from codesphere import CodesphereSDK
 
 
@@ -9,7 +7,7 @@ async def main():
         async with CodesphereSDK() as sdk:
             team_to_delete = await sdk.teams.get(team_id="<id>")
             print("\n--- Details of the team to be deleted ---")
-            pprint.pprint(team_to_delete.model_dump())
+            print(team_to_delete.model_dump_json(indent=2))
             await team_to_delete.delete()
             print(f"Team with ID {team_to_delete.id} was successfully deleted.")
 
diff --git a/examples/teams/get_team.py b/examples/teams/get_team.py
@@ -1,5 +1,4 @@
 import asyncio
-import pprint
 
 from codesphere import CodesphereSDK
 
@@ -8,9 +7,10 @@ async def main():
     try:
         async with CodesphereSDK() as sdk:
             teams = await sdk.teams.list()
+            print(teams[0].model_dump_json(indent=2))
             first_team = await sdk.teams.get(team_id=teams[0].id)
             print("\n--- Details for the first team ---")
-            pprint.pprint(first_team.model_dump())
+            print(first_team.model_dump_json(indent=2))
 
     except Exception as e:
         print(f"An error occurred: {e}")
diff --git a/examples/teams/list_teams.py b/examples/teams/list_teams.py
@@ -7,9 +7,8 @@ async def main():
     try:
         async with CodesphereSDK() as sdk:
             teams = await sdk.teams.list()
-            print(f"Found {len(teams)} teams:")
             for team in teams:
-                print(f"Team ID: {team.id}, Name: {team.name}")
+                print(team.model_dump_json(indent=2))
 
     except Exception as e:
         print(f"An error occurred: {e}")
diff --git a/examples/workspaces/env-vars/delete_envvars.py b/examples/workspaces/env-vars/delete_envvars.py
@@ -15,11 +15,14 @@ async def main():
         print("Current Environment Variables:")
         pprint.pprint(envs[0].name)
 
-        await workspace.delete_env_vars([envs[0].name])  # you can pass a list of strings to delete multiple env vars
+        await workspace.delete_env_vars(
+            [envs[0].name]
+        )  # you can pass a list of strings to delete multiple env vars
 
         print("Environment Variables after deletion:")
         updated_envs = await workspace.get_env_vars()
         pprint.pprint(updated_envs)
 
+
 if __name__ == "__main__":
     asyncio.run(main())
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,7 +14,9 @@ dependencies = [
     "aiohttp-retry>=2.9.1",
     "httpx>=0.28.1",
     "pydantic>=2.11.7",
+    "pydantic-settings>=2.11.0",
     "python-dateutil>=2.9.0.post0",
+    "python-dotenv>=1.2.1",
     "typing-extensions>=4.14.0",
     "urllib3>=2.4.0",
 ]
diff --git a/src/codesphere/__init__.py b/src/codesphere/__init__.py
@@ -1,6 +1,5 @@
-# z.B. in src/codesphere/__init__.py oder einer eigenen client.py
 from .client import APIHttpClient
-from .resources.team.resources import TeamsResource
+from .resources.team.resources import TeamsResource, TeamCreate
 from .resources.workspace.resources import WorkspacesResource
 from .resources.metadata.resources import MetadataResource
 from .resources.workspace.models import (
diff --git a/src/codesphere/client.py b/src/codesphere/client.py
@@ -1,29 +1,25 @@
-import os
 import httpx
 from pydantic import BaseModel
 from typing import Optional, Any
 from functools import partial
 
-from .resources.exceptions.exceptions import AuthenticationError
+from .config import settings
 
 
 class APIHttpClient:
     def __init__(self, base_url: str = "https://codesphere.com/api"):
-        auth_token = os.environ.get("CS_TOKEN")
-
-        if not auth_token:
-            raise AuthenticationError()
-
-        self._token = auth_token
-        self._base_url = base_url
+        self._token = settings.token.get_secret_value()
+        self._base_url = base_url or str(settings.base_url)
         self.client: Optional[httpx.AsyncClient] = None
 
         # Dynamically create get, post, put, patch, delete methods
         for method in ["get", "post", "put", "patch", "delete"]:
             setattr(self, method, partial(self.request, method.upper()))
 
     async def __aenter__(self):
-        timeout_config = httpx.Timeout(10.0, read=30.0)
+        timeout_config = httpx.Timeout(
+            settings.client_timeout_connect, read=settings.client_timeout_read
+        )
         self.client = httpx.AsyncClient(
             base_url=self._base_url,
             headers={"Authorization": f"Bearer {self._token}"},
diff --git a/src/codesphere/config.py b/src/codesphere/config.py
@@ -0,0 +1,23 @@
+from pydantic import HttpUrl, SecretStr
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    """
+    API Client Settings
+
+    TODO: add List of available env vars
+    """
+
+    model_config = SettingsConfigDict(
+        env_file=".env", env_file_encoding="utf-8", env_prefix="CS_"
+    )
+
+    token: SecretStr
+    base_url: HttpUrl = "https://codesphere.com/api"
+
+    client_timeout_connect: float = 10.0
+    client_timeout_read: float = 30.0
+
+
+settings = Settings()
diff --git a/src/codesphere/resources/metadata/resources.py b/src/codesphere/resources/metadata/resources.py
@@ -1,25 +1,28 @@
-from typing import List
+from typing import Awaitable, Callable, List
 from ..base import ResourceBase, APIOperation
 from .models import Datacenters, WsPlans, Images
 
 
 class MetadataResource(ResourceBase):
     """Contains all API operations for team ressources."""
 
+    datacenters: Callable[[], Awaitable[List[Datacenters]]]
     datacenters = APIOperation(
         method="GET",
         endpoint_template="/metadata/datacenters",
         input_model=None,
         response_model=List[Datacenters],
     )
 
+    plans: Callable[[], Awaitable[List[WsPlans]]]
     plans = APIOperation(
         method="GET",
         endpoint_template="/metadata/workspace-plans",
         input_model=None,
         response_model=List[WsPlans],
     )
 
+    images: Callable[[], Awaitable[List[Images]]]
     images = APIOperation(
         method="GET",
         endpoint_template="/metadata/workspace-base-images",
diff --git a/src/codesphere/resources/team/models.py b/src/codesphere/resources/team/models.py
@@ -26,12 +26,6 @@ class TeamBase(BaseModel):
     role: Optional[int] = None
 
 
-class TeamInList(TeamBase):
-    """Represents a team as it appears in the list response."""
-
-    role: int
-
-
 class Team(TeamBase):
     """
     Represents a complete, single team object (detail view).
diff --git a/src/codesphere/resources/team/resources.py b/src/codesphere/resources/team/resources.py
@@ -1,32 +1,49 @@
-from typing import List
+from asyncio import Protocol
+from typing import Awaitable, Callable, List
 from ..base import ResourceBase, APIOperation
 from .models import Team, TeamCreate
 
 
+class GetTeamCallable(Protocol):
+    async def __call__(self, *, team_id: int) -> Team: ...
+
+
+class CreateTeamCallable(Protocol):
+    async def __call__(self, *, data: TeamCreate) -> Team: ...
+
+
+class DeleteTeamCallable(Protocol):
+    async def __call__(self, *, team_id: int) -> None: ...
+
+
 class TeamsResource(ResourceBase):
     """Contains all API operations for team ressources."""
 
+    list: Callable[[], Awaitable[List[Team]]]
     list = APIOperation(
         method="GET",
         endpoint_template="/teams",
         input_model=None,
         response_model=List[Team],
     )
 
+    get: GetTeamCallable
     get = APIOperation(
         method="GET",
         endpoint_template="/teams/{team_id}",
         input_model=None,
         response_model=Team,
     )
 
+    create: CreateTeamCallable
     create = APIOperation(
         method="POST",
         endpoint_template="/teams",
         input_model=TeamCreate,
         response_model=Team,
     )
 
+    delete: DeleteTeamCallable
     delete = APIOperation(
         method="DELETE",
         endpoint_template="/teams/{team_id}",
diff --git a/uv.lock b/uv.lock

-Original file line number
+Diff line change
 .venv/
 venv/
 env/
 +*.env
 .pytest_cache