skillforge-client 0.3.0__py3-none-any.whl

skillforge_client/client.py

@@ -0,0 +1,268 @@
+import ssl
+from typing import Any
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

skillforge_client/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

skillforge_client/models/__init__.py

@@ -0,0 +1,167 @@
+"""Contains all the data models used in inputs/outputs"""
+
+from .access_token_response import AccessTokenResponse
+from .application_client_create_request import ApplicationClientCreateRequest
+from .application_client_response import ApplicationClientResponse
+from .application_client_scope_grant_request import ApplicationClientScopeGrantRequest
+from .application_client_secret_create_request import ApplicationClientSecretCreateRequest
+from .application_client_secret_response import ApplicationClientSecretResponse
+from .application_client_status import ApplicationClientStatus
+from .application_client_update_request import ApplicationClientUpdateRequest
+from .authorization_check_request import AuthorizationCheckRequest
+from .authorization_check_response import AuthorizationCheckResponse
+from .body_create_token_api_v1_auth_token_post import BodyCreateTokenApiV1AuthTokenPost
+from .bot_job import BotJob
+from .bot_job_payload import BotJobPayload
+from .bot_principal import BotPrincipal
+from .command_env_channel_response import CommandEnvChannelResponse
+from .command_env_kind import CommandEnvKind
+from .command_env_upsert_request import CommandEnvUpsertRequest
+from .contact_info_profile import ContactInfoProfile
+from .contact_info_type import ContactInfoType
+from .created_client_secret_response import CreatedClientSecretResponse
+from .dependencies_health_check_response import DependenciesHealthCheckResponse
+from .dependencies_health_check_response_checks import DependenciesHealthCheckResponseChecks
+from .dependency_health_check_response import DependencyHealthCheckResponse
+from .dependency_name import DependencyName
+from .discord_account_link_request import DiscordAccountLinkRequest
+from .discord_account_link_response import DiscordAccountLinkResponse
+from .discord_account_profile import DiscordAccountProfile
+from .discord_id_batch_request import DiscordIdBatchRequest
+from .discord_user_response import DiscordUserResponse
+from .discord_user_upsert_request import DiscordUserUpsertRequest
+from .error_response import ErrorResponse
+from .external_accounts_profile import ExternalAccountsProfile
+from .group_membership_response import GroupMembershipResponse
+from .health_check_response import HealthCheckResponse
+from .health_status import HealthStatus
+from .http_validation_error import HTTPValidationError
+from .job_claim_request import JobClaimRequest
+from .job_detail import JobDetail
+from .job_detail_payload import JobDetailPayload
+from .job_fail_request import JobFailRequest
+from .job_kind_counts import JobKindCounts
+from .job_list_item import JobListItem
+from .job_page import JobPage
+from .job_queue_summary import JobQueueSummary
+from .job_response import JobResponse
+from .job_status import JobStatus
+from .job_status_counts import JobStatusCounts
+from .member_role import MemberRole
+from .microsoft_account_profile import MicrosoftAccountProfile
+from .operation_cancel_response import OperationCancelResponse
+from .operation_kind import OperationKind
+from .operation_page import OperationPage
+from .operation_response import OperationResponse
+from .operation_response_plan import OperationResponsePlan
+from .operation_status import OperationStatus
+from .operation_summary import OperationSummary
+from .operational_profile import OperationalProfile
+from .party_relation_type import PartyRelationType
+from .person_profile import PersonProfile
+from .principal_batch import PrincipalBatch
+from .relation_profile import RelationProfile
+from .relation_profile_direction import RelationProfileDirection
+from .student_activation_commit_request import StudentActivationCommitRequest
+from .student_activation_prepare_request import StudentActivationPrepareRequest
+from .student_channel_state import StudentChannelState
+from .student_context import StudentContext
+from .student_context_batch import StudentContextBatch
+from .system_health_check_response import SystemHealthCheckResponse
+from .transition_commit_response import TransitionCommitResponse
+from .transition_prepare_response import TransitionPrepareResponse
+from .transition_prepare_response_plan import TransitionPrepareResponsePlan
+from .tutor_activation_commit_request import TutorActivationCommitRequest
+from .tutor_activation_prepare_request import TutorActivationPrepareRequest
+from .tutor_context import TutorContext
+from .tutor_context_batch import TutorContextBatch
+from .validation_error import ValidationError
+from .validation_error_context import ValidationErrorContext
+from .worker_health_check_response import WorkerHealthCheckResponse
+from .worker_name import WorkerName
+from .workers_health_check_response import WorkersHealthCheckResponse
+from .workers_health_check_response_checks import WorkersHealthCheckResponseChecks
+
+__all__ = (
+    "AccessTokenResponse",
+    "ApplicationClientCreateRequest",
+    "ApplicationClientResponse",
+    "ApplicationClientScopeGrantRequest",
+    "ApplicationClientSecretCreateRequest",
+    "ApplicationClientSecretResponse",
+    "ApplicationClientStatus",
+    "ApplicationClientUpdateRequest",
+    "AuthorizationCheckRequest",
+    "AuthorizationCheckResponse",
+    "BodyCreateTokenApiV1AuthTokenPost",
+    "BotJob",
+    "BotJobPayload",
+    "BotPrincipal",
+    "CommandEnvChannelResponse",
+    "CommandEnvKind",
+    "CommandEnvUpsertRequest",
+    "ContactInfoProfile",
+    "ContactInfoType",
+    "CreatedClientSecretResponse",
+    "DependenciesHealthCheckResponse",
+    "DependenciesHealthCheckResponseChecks",
+    "DependencyHealthCheckResponse",
+    "DependencyName",
+    "DiscordAccountLinkRequest",
+    "DiscordAccountLinkResponse",
+    "DiscordAccountProfile",
+    "DiscordIdBatchRequest",
+    "DiscordUserResponse",
+    "DiscordUserUpsertRequest",
+    "ErrorResponse",
+    "ExternalAccountsProfile",
+    "GroupMembershipResponse",
+    "HealthCheckResponse",
+    "HealthStatus",
+    "HTTPValidationError",
+    "JobClaimRequest",
+    "JobDetail",
+    "JobDetailPayload",
+    "JobFailRequest",
+    "JobKindCounts",
+    "JobListItem",
+    "JobPage",
+    "JobQueueSummary",
+    "JobResponse",
+    "JobStatus",
+    "JobStatusCounts",
+    "MemberRole",
+    "MicrosoftAccountProfile",
+    "OperationalProfile",
+    "OperationCancelResponse",
+    "OperationKind",
+    "OperationPage",
+    "OperationResponse",
+    "OperationResponsePlan",
+    "OperationStatus",
+    "OperationSummary",
+    "PartyRelationType",
+    "PersonProfile",
+    "PrincipalBatch",
+    "RelationProfile",
+    "RelationProfileDirection",
+    "StudentActivationCommitRequest",
+    "StudentActivationPrepareRequest",
+    "StudentChannelState",
+    "StudentContext",
+    "StudentContextBatch",
+    "SystemHealthCheckResponse",
+    "TransitionCommitResponse",
+    "TransitionPrepareResponse",
+    "TransitionPrepareResponsePlan",
+    "TutorActivationCommitRequest",
+    "TutorActivationPrepareRequest",
+    "TutorContext",
+    "TutorContextBatch",
+    "ValidationError",
+    "ValidationErrorContext",
+    "WorkerHealthCheckResponse",
+    "WorkerName",
+    "WorkersHealthCheckResponse",
+    "WorkersHealthCheckResponseChecks",
+)

skillforge_client/models/access_token_response.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="AccessTokenResponse")
+
+
+@_attrs_define
+class AccessTokenResponse:
+    """
+    Attributes:
+        access_token (str):
+        expires_in (int):
+        scope (str):
+        token_type (str):
+    """
+
+    access_token: str
+    expires_in: int
+    scope: str
+    token_type: str
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        access_token = self.access_token
+
+        expires_in = self.expires_in
+
+        scope = self.scope
+
+        token_type = self.token_type
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "access_token": access_token,
+                "expires_in": expires_in,
+                "scope": scope,
+                "token_type": token_type,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        access_token = d.pop("access_token")
+
+        expires_in = d.pop("expires_in")
+
+        scope = d.pop("scope")
+
+        token_type = d.pop("token_type")
+
+        access_token_response = cls(
+            access_token=access_token,
+            expires_in=expires_in,
+            scope=scope,
+            token_type=token_type,
+        )
+
+        access_token_response.additional_properties = d
+        return access_token_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

skillforge_client/models/application_client_create_request.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="ApplicationClientCreateRequest")
+
+
+@_attrs_define
+class ApplicationClientCreateRequest:
+    """
+    Attributes:
+        client_id (str):
+        name (str):
+        description (None | str | Unset):
+    """
+
+    client_id: str
+    name: str
+    description: None | str | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        client_id = self.client_id
+
+        name = self.name
+
+        description: None | str | Unset
+        if isinstance(self.description, Unset):
+            description = UNSET
+        else:
+            description = self.description
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "client_id": client_id,
+                "name": name,
+            }
+        )
+        if description is not UNSET:
+            field_dict["description"] = description
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        client_id = d.pop("client_id")
+
+        name = d.pop("name")
+
+        def _parse_description(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        description = _parse_description(d.pop("description", UNSET))
+
+        application_client_create_request = cls(
+            client_id=client_id,
+            name=name,
+            description=description,
+        )
+
+        application_client_create_request.additional_properties = d
+        return application_client_create_request
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties