timeback-powerpath 0.2.0__tar.gz → 0.2.1__tar.gz

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/.gitignore

@@ -1,3 +1,6 @@
+# ai
+.claude
+
 # Python
 __pycache__/
 *.py[cod]

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: timeback-powerpath
-Version: 0.2.0
+Version: 0.2.1
 Summary: Timeback PowerPath client for adaptive learning operations
 Project-URL: Homepage, https://developer.timeback.com
 Project-URL: Documentation, https://docs.timeback.com

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "timeback-powerpath"
-version = "0.2.0"
+version = "0.2.1"
 description = "Timeback PowerPath client for adaptive learning operations"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.12"

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/__init__.py

@@ -82,6 +82,7 @@ from .types import (
     GetNextQuestionParams,
     GetNextQuestionResponse,
     GetSubjectProgressResponse,
+    GetTestOutEligibilityResponse,
     ImportExternalResultsResponse,
     ImportExternalTestAssignmentResultsParams,
     InternalTestCreateResponse,
@@ -100,6 +101,8 @@ from .types import (
     LessonPlanSyncResult,
     LessonPlanTarget,
     LessonPlanUpdateStudentItemResponseInput,
+    MakeExternalStudentTestOutAssignmentInput,
+    MakeExternalStudentTestOutAssignmentResponse,
     MakeExternalTestAssignmentInput,
     MakeExternalTestAssignmentResponse,
     MoveItemAfterOperation,
@@ -119,6 +122,10 @@ from .types import (
     QtiTestConfig,
     QuizLikeLessonType,
     RemainingQuestionsPerDifficulty,
+    RenderConfigDeleteResponse,
+    RenderConfigGetResponse,
+    RenderConfigUpsertInput,
+    RenderConfigUpsertResponse,
     ResetAttemptInput,
     ResetAttemptResponse,
     ResetPlacementResponse,
@@ -192,6 +199,7 @@ __all__ = [
     "GetNextQuestionParams",
     "GetNextQuestionResponse",
     "GetSubjectProgressResponse",
+    "GetTestOutEligibilityResponse",
     "ImportExternalResultsResponse",
     "ImportExternalTestAssignmentResultsParams",
     "InputValidationError",
@@ -211,6 +219,8 @@ __all__ = [
     "LessonPlanTarget",
     "LessonPlanUpdateStudentItemResponseInput",
     "LessonPlansCreateInput",
+    "MakeExternalStudentTestOutAssignmentInput",
+    "MakeExternalStudentTestOutAssignmentResponse",
     "MakeExternalTestAssignmentInput",
     "MakeExternalTestAssignmentResponse",
     "MoveItemAfterOperation",
@@ -234,6 +244,10 @@ __all__ = [
     "QuizLikeLessonType",
     "RateLimitError",
     "RemainingQuestionsPerDifficulty",
+    "RenderConfigDeleteResponse",
+    "RenderConfigGetResponse",
+    "RenderConfigUpsertInput",
+    "RenderConfigUpsertResponse",
     "ResetAttemptInput",
     "ResetAttemptResponse",
     "ResetPlacementResponse",

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/client.py

@@ -12,9 +12,11 @@ from .lib.transport import Transport
 from .resources.assessment import AssessmentResource
 from .resources.lesson_plans import LessonPlansResource
 from .resources.placement import PlacementResource
+from .resources.render_config import RenderConfigResource
 from .resources.screening import ScreeningResource
 from .resources.syllabus import SyllabusResource
 from .resources.test_assignments import TestAssignmentsResource
+from .resources.test_out import TestOutResource
 
 if TYPE_CHECKING:
     from timeback_common import AuthCheckResult, Environment, PowerPathPaths, TimebackProvider
@@ -171,9 +173,11 @@ class PowerPathClient:
         self.assessments = AssessmentResource(_transport)
         self.lesson_plans = LessonPlansResource(_transport)
         self.placement = PlacementResource(_transport)
+        self.render_config = RenderConfigResource(_transport)
         self.screening = ScreeningResource(_transport)
         self.syllabus = SyllabusResource(_transport)
         self.test_assignments = TestAssignmentsResource(_transport)
+        self.test_out = TestOutResource(_transport)
 
     def get_transport(self) -> Transport | PowerPathTransportLike:
         """

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/lib/testing.py

@@ -21,6 +21,7 @@ from ..types.responses import (
     GetNextPlacementTestResponse,
     GetNextQuestionResponse,
     GetSubjectProgressResponse,
+    GetTestOutEligibilityResponse,
     ImportExternalResultsResponse,
     InternalTestCreateResponse,
     LessonPlanCourseSyncResult,
@@ -30,8 +31,12 @@ from ..types.responses import (
     LessonPlanOperationsResponse,
     LessonPlanResponse,
     LessonPlanSyncResult,
+    MakeExternalStudentTestOutAssignmentResponse,
     MakeExternalTestAssignmentResponse,
     PowerPathTestQuestion,
+    RenderConfigDeleteResponse,
+    RenderConfigGetResponse,
+    RenderConfigUpsertResponse,
     ResetAttemptResponse,
     ResetPlacementResponse,
     ScreeningAssignTestResponse,
@@ -73,6 +78,8 @@ class PowerPathRecordingTransport(BaseRecordingTransport):
             _placement_get_stub,
             _lesson_plans_get_stub,
             _assessment_get_stub,
+            _render_config_get_stub,
+            _test_out_get_stub,
         ):
             response = resolver(path)
             if response is not None:
@@ -86,6 +93,7 @@ class PowerPathRecordingTransport(BaseRecordingTransport):
             _placement_post_stub,
             _lesson_plans_post_stub,
             _assessment_post_stub,
+            _test_out_post_stub,
         ):
             response = resolver(path)
             if response is not None:
@@ -96,12 +104,20 @@ class PowerPathRecordingTransport(BaseRecordingTransport):
         for resolver in (
             _assignments_put_stub,
             _assessment_put_stub,
+            _render_config_put_stub,
         ):
             response = resolver(path)
             if response is not None:
                 return response
         return {}
 
+    def _default_delete_stub(self, path: str) -> dict[str, Any]:
+        for resolver in (_render_config_delete_stub,):
+            response = resolver(path)
+            if response is not None:
+                return response
+        return {}
+
 
 def _assessment_standard_progress_stub() -> StandardProgressResponse:
     return StandardProgressResponse.model_validate(
@@ -462,4 +478,57 @@ def _syllabus_get_stub(path: str) -> dict[str, Any] | None:
     return None
 
 
+def _render_config_get_stub(path: str) -> dict[str, Any] | None:
+    if "/render-config/" in path:
+        return dump_model(
+            RenderConfigGetResponse.model_validate(
+                {
+                    "courseId": "course-001",
+                    "rendererId": "renderer-001",
+                    "rendererUrl": "https://renderer.example.com",
+                    "suppressFeedback": False,
+                    "suppressCorrectResponse": False,
+                }
+            ),
+            exclude_none=False,
+        )
+    return None
+
+
+def _render_config_put_stub(path: str) -> dict[str, Any] | None:
+    if "/render-config/" in path:
+        return dump_model(
+            RenderConfigUpsertResponse(updated=["course-001"]),
+            exclude_none=False,
+        )
+    return None
+
+
+def _render_config_delete_stub(path: str) -> dict[str, Any] | None:
+    if "/render-config/" in path:
+        return dump_model(
+            RenderConfigDeleteResponse(deleted="course-001"),
+            exclude_none=False,
+        )
+    return None
+
+
+def _test_out_get_stub(path: str) -> dict[str, Any] | None:
+    if "/test-out/getTestOutEligibility/" in path:
+        return dump_model(
+            GetTestOutEligibilityResponse(eligible=True, reason=None),
+            exclude_none=False,
+        )
+    return None
+
+
+def _test_out_post_stub(path: str) -> dict[str, Any] | None:
+    if "/test-out/makeExternalStudentTestOutAssignment" in path:
+        return dump_model(
+            MakeExternalStudentTestOutAssignmentResponse(success=True, data=None),
+            exclude_none=False,
+        )
+    return None
+
+
 __all__ = ["PowerPathRecordingTransport", "create_recording_transport"]

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/resources/__init__.py

@@ -7,15 +7,19 @@ Resource classes for PowerPath API operations.
 from .assessment import AssessmentResource
 from .lesson_plans import LessonPlansResource
 from .placement import PlacementResource
+from .render_config import RenderConfigResource
 from .screening import ScreeningResource
 from .syllabus import SyllabusResource
 from .test_assignments import TestAssignmentsResource
+from .test_out import TestOutResource
 
 __all__ = [
     "AssessmentResource",
     "LessonPlansResource",
     "PlacementResource",
+    "RenderConfigResource",
     "ScreeningResource",
     "SyllabusResource",
     "TestAssignmentsResource",
+    "TestOutResource",
 ]

timeback_powerpath-0.2.1/src/timeback_powerpath/resources/render_config.py

@@ -0,0 +1,84 @@
+"""
+Render Config Resource
+
+PowerPath custom renderer configuration operations.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+from urllib.parse import quote
+
+from timeback_common import serialize_input, validate_non_empty_string, validate_with_schema
+
+from ..types.inputs import RenderConfigUpsertInput
+from ..types.responses import (
+    RenderConfigDeleteResponse,
+    RenderConfigGetResponse,
+    RenderConfigUpsertResponse,
+)
+
+if TYPE_CHECKING:
+    from ..lib.transport import Transport
+
+
+class RenderConfigResource:
+    """Render config resource for managing custom renderer configurations on courses."""
+
+    def __init__(self, transport: Transport) -> None:
+        self._transport = transport
+
+    @property
+    def _base_path(self) -> str:
+        return self._transport.paths.base
+
+    async def upsert(
+        self, input: RenderConfigUpsertInput | dict[str, Any]
+    ) -> RenderConfigUpsertResponse:
+        """
+        Upsert render config for one or more courses.
+
+        Args:
+            input: Render config data including course_ids, renderer_id, and renderer_url
+
+        Returns:
+            List of updated course IDs
+        """
+        validate_with_schema(RenderConfigUpsertInput, input, "render config upsert")
+        body = await self._transport.put(
+            f"{self._base_path}/render-config/",
+            serialize_input(input, RenderConfigUpsertInput),
+        )
+        return RenderConfigUpsertResponse.model_validate(body)
+
+    async def get(self, course_id: str) -> RenderConfigGetResponse:
+        """
+        Get render config for a course.
+
+        Args:
+            course_id: The course ID to look up
+
+        Returns:
+            The render config for the course
+        """
+        validate_non_empty_string(course_id, "course_id")
+        body = await self._transport.get(
+            f"{self._base_path}/render-config/{quote(course_id, safe='')}"
+        )
+        return RenderConfigGetResponse.model_validate(body)
+
+    async def delete(self, course_id: str) -> RenderConfigDeleteResponse:
+        """
+        Delete render config for a course.
+
+        Args:
+            course_id: The course ID whose render config to delete
+
+        Returns:
+            Confirmation with the deleted course ID
+        """
+        validate_non_empty_string(course_id, "course_id")
+        body = await self._transport.delete(
+            f"{self._base_path}/render-config/{quote(course_id, safe='')}"
+        )
+        return RenderConfigDeleteResponse.model_validate(body)

timeback_powerpath-0.2.1/src/timeback_powerpath/resources/test_out.py

@@ -0,0 +1,73 @@
+"""
+Test Out Resource
+
+PowerPath self-elected test-out operations.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+from urllib.parse import quote
+
+from timeback_common import serialize_input, validate_non_empty_string, validate_with_schema
+
+from ..types.inputs import MakeExternalStudentTestOutAssignmentInput
+from ..types.responses import (
+    GetTestOutEligibilityResponse,
+    MakeExternalStudentTestOutAssignmentResponse,
+)
+
+if TYPE_CHECKING:
+    from ..lib.transport import Transport
+
+
+class TestOutResource:
+    """Test out resource for self-elected test-out eligibility and assignment creation."""
+
+    def __init__(self, transport: Transport) -> None:
+        self._transport = transport
+
+    @property
+    def _base_path(self) -> str:
+        return self._transport.paths.base
+
+    async def get_eligibility(self, student_id: str, subject: str) -> GetTestOutEligibilityResponse:
+        """
+        Check if a student is eligible to self-request a test-out for a subject.
+
+        Args:
+            student_id: The student's OneRoster sourcedId
+            subject: The subject to check eligibility for
+
+        Returns:
+            Eligibility status and optional reason
+        """
+        validate_non_empty_string(student_id, "student_id")
+        validate_non_empty_string(subject, "subject")
+        body = await self._transport.get(
+            f"{self._base_path}/test-out/getTestOutEligibility/{quote(student_id, safe='')}/{quote(subject, safe='')}"
+        )
+        return GetTestOutEligibilityResponse.model_validate(body)
+
+    async def create_assignment(
+        self, input: MakeExternalStudentTestOutAssignmentInput | dict[str, Any]
+    ) -> MakeExternalStudentTestOutAssignmentResponse:
+        """
+        Create a self-elected test-out assignment.
+
+        Args:
+            input: Assignment data including one_roster_sourced_id and subject
+
+        Returns:
+            Success status and optional data
+        """
+        validate_with_schema(
+            MakeExternalStudentTestOutAssignmentInput,
+            input,
+            "make external student test out assignment",
+        )
+        body = await self._transport.post(
+            f"{self._base_path}/test-out/makeExternalStudentTestOutAssignment",
+            serialize_input(input, MakeExternalStudentTestOutAssignmentInput),
+        )
+        return MakeExternalStudentTestOutAssignmentResponse.model_validate(body)

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/types/inputs.py

@@ -511,6 +511,38 @@ class PlacementResetUserPlacementInput(BaseModel):
     model_config = {"populate_by_name": True}
 
 
+# ═══════════════════════════════════════════════════════════════════════════════
+# SELF-ELECTED TEST-OUT INPUTS
+# ═══════════════════════════════════════════════════════════════════════════════
+
+
+class MakeExternalStudentTestOutAssignmentInput(BaseModel):
+    """Input for creating a self-elected test-out assignment."""
+
+    one_roster_sourced_id: NonEmptyString = Field(alias="oneRosterSourcedId")
+    subject: NonEmptyString
+
+    model_config = {"populate_by_name": True}
+
+
+# ═══════════════════════════════════════════════════════════════════════════════
+# RENDER CONFIG INPUTS
+# ═══════════════════════════════════════════════════════════════════════════════
+
+
+class RenderConfigUpsertInput(BaseModel):
+    """Input for upserting render config for one or more courses."""
+
+    course_ids: list[NonEmptyString] = Field(alias="courseIds", min_length=1)
+    renderer_id: NonEmptyString = Field(alias="rendererId")
+    renderer_url: HttpUrl = Field(alias="rendererUrl")
+    renderer_version: NonEmptyString | None = Field(default=None, alias="rendererVersion")
+    suppress_feedback: bool | None = Field(default=None, alias="suppressFeedback")
+    suppress_correct_response: bool | None = Field(default=None, alias="suppressCorrectResponse")
+
+    model_config = {"populate_by_name": True}
+
+
 # ═══════════════════════════════════════════════════════════════════════════════
 # SCREENING INPUTS
 # ═══════════════════════════════════════════════════════════════════════════════
@@ -567,6 +599,7 @@ __all__ = [
     "LessonPlanTarget",
     "LessonPlanUpdateStudentItemResponseInput",
     "LessonPlansCreateInput",
+    "MakeExternalStudentTestOutAssignmentInput",
     "MakeExternalTestAssignmentInput",
     "MoveItemAfterOperation",
     "MoveItemBeforeOperation",
@@ -575,6 +608,7 @@ __all__ = [
     "PlacementQueryParams",
     "PlacementResetUserPlacementInput",
     "QtiTestConfig",
+    "RenderConfigUpsertInput",
     "ResetAttemptInput",
     "ScreeningAssignTestInput",
     "ScreeningResetSessionInput",

{timeback_powerpath-0.2.0 → timeback_powerpath-0.2.1}/src/timeback_powerpath/types/responses.py

@@ -607,6 +607,55 @@ class UpdateStudentItemResponseResult(BaseModel):
     model_config = {"extra": "allow"}
 
 
+# ═══════════════════════════════════════════════════════════════════════════════
+# TEST OUT (self-elected)
+# ═══════════════════════════════════════════════════════════════════════════════
+
+
+class GetTestOutEligibilityResponse(BaseModel):
+    """Result from checking test-out eligibility for a student/subject."""
+
+    eligible: bool
+    reason: str | None = None
+
+
+class MakeExternalStudentTestOutAssignmentResponse(BaseModel):
+    """Result from creating a self-elected test-out assignment."""
+
+    success: bool
+    data: dict[str, Any] | None = None
+
+
+# ═══════════════════════════════════════════════════════════════════════════════
+# RENDER CONFIG
+# ═══════════════════════════════════════════════════════════════════════════════
+
+
+class RenderConfigUpsertResponse(BaseModel):
+    """Result from upserting render configs for one or more courses."""
+
+    updated: list[str]
+
+
+class RenderConfigGetResponse(BaseModel):
+    """Render config for a single course."""
+
+    course_id: str = Field(alias="courseId")
+    renderer_id: str = Field(alias="rendererId")
+    renderer_url: str = Field(alias="rendererUrl")
+    renderer_version: str | None = Field(default=None, alias="rendererVersion")
+    suppress_feedback: bool = Field(alias="suppressFeedback")
+    suppress_correct_response: bool = Field(alias="suppressCorrectResponse")
+
+    model_config = {"populate_by_name": True}
+
+
+class RenderConfigDeleteResponse(BaseModel):
+    """Result from deleting a render config."""
+
+    deleted: str
+
+
 # ═══════════════════════════════════════════════════════════════════════════════
 # SYLLABUS
 # ═══════════════════════════════════════════════════════════════════════════════
@@ -634,6 +683,7 @@ __all__ = [
     "GetNextPlacementTestResponse",
     "GetNextQuestionResponse",
     "GetSubjectProgressResponse",
+    "GetTestOutEligibilityResponse",
     "ImportExternalResultsResponse",
     "InternalTestCreateResponse",
     "LessonPlanCourseSyncResult",
@@ -643,6 +693,7 @@ __all__ = [
     "LessonPlanOperationsResponse",
     "LessonPlanResponse",
     "LessonPlanSyncResult",
+    "MakeExternalStudentTestOutAssignmentResponse",
     "MakeExternalTestAssignmentResponse",
     "PaginationMeta",
     "PowerPath100ProgressResponse",
@@ -651,6 +702,9 @@ __all__ = [
     "PowerPathQuestionResult",
     "PowerPathTestQuestion",
     "RemainingQuestionsPerDifficulty",
+    "RenderConfigDeleteResponse",
+    "RenderConfigGetResponse",
+    "RenderConfigUpsertResponse",
     "ResetAttemptResponse",
     "ResetPlacementResponse",
     "ResponseResult",

timeback_powerpath-0.2.1/tests/fixtures/test_render_config.py

@@ -0,0 +1,23 @@
+"""Fixture-driven tests for PowerPath render config resource."""
+
+from __future__ import annotations
+
+from test_support.fixtures import fixtures_dir, make_resource_fixture_test
+from timeback_powerpath.lib.testing import create_recording_transport
+from timeback_powerpath.resources.render_config import RenderConfigResource
+
+FIXTURES_DIR = fixtures_dir("powerpath", "render-config")
+
+
+def _setup(
+    fail_request: dict[str, object] | None, transport_config: dict[str, object] | None
+) -> dict[str, object]:
+    transport = create_recording_transport(fail_request, transport_config)
+    return {"resource": RenderConfigResource(transport), "calls": transport.calls}
+
+
+test_powerpath_render_config_fixtures = make_resource_fixture_test(
+    name="powerpath > render-config",
+    fixtures_dir=FIXTURES_DIR,
+    setup=_setup,
+)

timeback_powerpath-0.2.1/tests/fixtures/test_test_out.py

@@ -0,0 +1,23 @@
+"""Fixture-driven tests for PowerPath test out resource."""
+
+from __future__ import annotations
+
+from test_support.fixtures import fixtures_dir, make_resource_fixture_test
+from timeback_powerpath.lib.testing import create_recording_transport
+from timeback_powerpath.resources.test_out import TestOutResource as PowerPathTestOutResource
+
+FIXTURES_DIR = fixtures_dir("powerpath", "test-out")
+
+
+def _setup(
+    fail_request: dict[str, object] | None, transport_config: dict[str, object] | None
+) -> dict[str, object]:
+    transport = create_recording_transport(fail_request, transport_config)
+    return {"resource": PowerPathTestOutResource(transport), "calls": transport.calls}
+
+
+test_powerpath_test_out_fixtures = make_resource_fixture_test(
+    name="powerpath > test-out",
+    fixtures_dir=FIXTURES_DIR,
+    setup=_setup,
+)