skillforge-client 0.3.0__tar.gz

skillforge_client-0.3.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.3
+Name: skillforge-client
+Version: 0.3.0
+Summary: Official Python client for the Skillforge API.
+Keywords: skillforge,api,client,openapi
+Author: Leon Weimann
+Author-email: Leon Weimann <coding@leonweimann.de>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/Nachhilfe-Leon-Weimann/skillforge
+Project-URL: Issues, https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues
+Project-URL: OpenAPI contract, https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.3.0/openapi.json
+Description-Content-Type: text/markdown
+
+# Skillforge Python Client
+
+Official, typed Python client for the Skillforge HTTP API. The package is generated from Skillforge's versioned OpenAPI contract and released with the matching Skillforge version.
+
+## Installation
+
+With [uv](https://docs.astral.sh/uv/):
+
+```console
+uv add skillforge-client
+```
+
+Or with pip:
+
+```console
+python -m pip install skillforge-client
+```
+
+## Quick start
+
+Use `AuthenticatedClient` for endpoints protected by a Skillforge bearer token:
+
+```python
+import os
+
+from skillforge_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url=os.environ["SKILLFORGE_URL"],
+    token=os.environ["SKILLFORGE_TOKEN"],
+)
+```
+
+Endpoint functions are grouped by their OpenAPI tag. For example, the liveness endpoint can be called synchronously:
+
+```python
+import os
+
+from skillforge_client import Client
+from skillforge_client.api.system import liveness_check_health_live_get
+
+with Client(base_url=os.environ["SKILLFORGE_URL"]) as client:
+    health = liveness_check_health_live_get.sync(client=client)
+
+if health is not None:
+    print(health.status.value)
+```
+
+Every generated endpoint module provides four variants:
+
+- `sync`: blocking call returning the parsed response or `None`
+- `sync_detailed`: blocking call returning status, headers, content, and the parsed response
+- `asyncio`: asynchronous call returning the parsed response or `None`
+- `asyncio_detailed`: asynchronous call returning the detailed response
+
+Generated request and response models are available from `skillforge_client.models`.
+
+## Versioning and source
+
+Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.3.0/openapi.json) contract for Skillforge v0.3.0; generated source is not maintained by hand.
+
+- [Skillforge repository](https://github.com/Nachhilfe-Leon-Weimann/skillforge)
+- [Issue tracker](https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues)

skillforge_client-0.3.0/README.md

@@ -0,0 +1,63 @@
+# Skillforge Python Client
+
+Official, typed Python client for the Skillforge HTTP API. The package is generated from Skillforge's versioned OpenAPI contract and released with the matching Skillforge version.
+
+## Installation
+
+With [uv](https://docs.astral.sh/uv/):
+
+```console
+uv add skillforge-client
+```
+
+Or with pip:
+
+```console
+python -m pip install skillforge-client
+```
+
+## Quick start
+
+Use `AuthenticatedClient` for endpoints protected by a Skillforge bearer token:
+
+```python
+import os
+
+from skillforge_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url=os.environ["SKILLFORGE_URL"],
+    token=os.environ["SKILLFORGE_TOKEN"],
+)
+```
+
+Endpoint functions are grouped by their OpenAPI tag. For example, the liveness endpoint can be called synchronously:
+
+```python
+import os
+
+from skillforge_client import Client
+from skillforge_client.api.system import liveness_check_health_live_get
+
+with Client(base_url=os.environ["SKILLFORGE_URL"]) as client:
+    health = liveness_check_health_live_get.sync(client=client)
+
+if health is not None:
+    print(health.status.value)
+```
+
+Every generated endpoint module provides four variants:
+
+- `sync`: blocking call returning the parsed response or `None`
+- `sync_detailed`: blocking call returning status, headers, content, and the parsed response
+- `asyncio`: asynchronous call returning the parsed response or `None`
+- `asyncio_detailed`: asynchronous call returning the detailed response
+
+Generated request and response models are available from `skillforge_client.models`.
+
+## Versioning and source
+
+Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.3.0/openapi.json) contract for Skillforge v0.3.0; generated source is not maintained by hand.
+
+- [Skillforge repository](https://github.com/Nachhilfe-Leon-Weimann/skillforge)
+- [Issue tracker](https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues)

skillforge_client-0.3.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "skillforge-client"
+version = "0.3.0"
+description = "Official Python client for the Skillforge API."
+requires-python = ">=3.11"
+readme = "README.md"
+keywords = [
+    "skillforge",
+    "api",
+    "client",
+    "openapi",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.23.1,<0.29.0",
+    "attrs>=22.2.0",
+]
+
+[[project.authors]]
+name = "Leon Weimann"
+email = "coding@leonweimann.de"
+
+[project.urls]
+Repository = "https://github.com/Nachhilfe-Leon-Weimann/skillforge"
+Issues = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues"
+"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.3.0/openapi.json"
+
+[tool.uv.build-backend]
+module-name = "skillforge_client"
+module-root = ""
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "F",
+    "I",
+    "UP",
+]
+
+[build-system]
+requires = ["uv_build>=0.12.0,<0.13"]
+build-backend = "uv_build"

skillforge_client-0.3.0/pyproject.toml.orig

@@ -0,0 +1,38 @@
+[project]
+name = "skillforge-client"
+version = "0.3.0"
+description = "Official Python client for the Skillforge API."
+authors = [{ name = "Leon Weimann", email = "coding@leonweimann.de" }]
+requires-python = ">=3.11"
+readme = "README.md"
+keywords = ["skillforge", "api", "client", "openapi"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.23.1,<0.29.0",
+    "attrs>=22.2.0",
+]
+
+[project.urls]
+Repository = "https://github.com/Nachhilfe-Leon-Weimann/skillforge"
+Issues = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues"
+"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.3.0/openapi.json"
+
+[tool.uv.build-backend]
+module-name = "skillforge_client"
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.12.0,<0.13"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

skillforge_client-0.3.0/skillforge_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing skillforge"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

skillforge_client-0.3.0/skillforge_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

skillforge_client-0.3.0/skillforge_client/api/auth/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

skillforge_client-0.3.0/skillforge_client/api/auth/create_application_client_endpoint_api_v1_auth_clients_post.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.application_client_create_request import ApplicationClientCreateRequest
+from ...models.application_client_response import ApplicationClientResponse
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: ApplicationClientCreateRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/auth/clients",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ApplicationClientResponse | HTTPValidationError | None:
+    if response.status_code == 201:
+        response_201 = ApplicationClientResponse.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ApplicationClientResponse | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientCreateRequest,
+) -> Response[ApplicationClientResponse | HTTPValidationError]:
+    """Create Application Client Endpoint
+
+    Args:
+        body (ApplicationClientCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApplicationClientResponse | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientCreateRequest,
+) -> ApplicationClientResponse | HTTPValidationError | None:
+    """Create Application Client Endpoint
+
+    Args:
+        body (ApplicationClientCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApplicationClientResponse | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientCreateRequest,
+) -> Response[ApplicationClientResponse | HTTPValidationError]:
+    """Create Application Client Endpoint
+
+    Args:
+        body (ApplicationClientCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApplicationClientResponse | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientCreateRequest,
+) -> ApplicationClientResponse | HTTPValidationError | None:
+    """Create Application Client Endpoint
+
+    Args:
+        body (ApplicationClientCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApplicationClientResponse | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

skillforge_client-0.3.0/skillforge_client/api/auth/create_application_client_secret_endpoint_api_v1_auth_clients_client_id_secrets_post.py

@@ -0,0 +1,182 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.application_client_secret_create_request import ApplicationClientSecretCreateRequest
+from ...models.created_client_secret_response import CreatedClientSecretResponse
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    client_id: str,
+    *,
+    body: ApplicationClientSecretCreateRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/auth/clients/{client_id}/secrets".format(
+            client_id=quote(str(client_id), safe=""),
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CreatedClientSecretResponse | HTTPValidationError | None:
+    if response.status_code == 201:
+        response_201 = CreatedClientSecretResponse.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[CreatedClientSecretResponse | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    client_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientSecretCreateRequest,
+) -> Response[CreatedClientSecretResponse | HTTPValidationError]:
+    """Create Application Client Secret Endpoint
+
+    Args:
+        client_id (str):
+        body (ApplicationClientSecretCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CreatedClientSecretResponse | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        client_id=client_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    client_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientSecretCreateRequest,
+) -> CreatedClientSecretResponse | HTTPValidationError | None:
+    """Create Application Client Secret Endpoint
+
+    Args:
+        client_id (str):
+        body (ApplicationClientSecretCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CreatedClientSecretResponse | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client_id=client_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    client_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientSecretCreateRequest,
+) -> Response[CreatedClientSecretResponse | HTTPValidationError]:
+    """Create Application Client Secret Endpoint
+
+    Args:
+        client_id (str):
+        body (ApplicationClientSecretCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CreatedClientSecretResponse | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        client_id=client_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    client_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: ApplicationClientSecretCreateRequest,
+) -> CreatedClientSecretResponse | HTTPValidationError | None:
+    """Create Application Client Secret Endpoint
+
+    Args:
+        client_id (str):
+        body (ApplicationClientSecretCreateRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CreatedClientSecretResponse | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client_id=client_id,
+            client=client,
+            body=body,
+        )
+    ).parsed