trismik 0.9.0__tar.gz → 0.9.1__tar.gz

{trismik-0.9.0 → trismik-0.9.1}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Cambridge Enterprise
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Cambridge Enterprise
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{trismik-0.9.0 → trismik-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: trismik
-Version: 0.9.0
+Version: 0.9.1
 Summary: 
 Author: Bartosz Kielczewski
 Author-email: bk352@cam.ac.uk
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: httpx (>=0.27.2,<0.28.0)
 Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
 Description-Content-Type: text/markdown
@@ -51,10 +52,3 @@ Contributing
 4. ```poetry install```
 5. ```poetry run pytest```
 
-Publishing to TestPyPi
-----------------------
-
-1. ```poetry config repositories.testpypi https://test.pypi.org/legacy/```
-2. ```poetry config pypi-token.testpypi <token>```
-3. ```poetry publish --build --repository testpypi```
-

{trismik-0.9.0 → trismik-0.9.1}/README.md

@@ -1,42 +1,35 @@
-Trismik Python SDK
-==================
-
-This is the official Python SDK for Trismik. It provides a simple way to interact with the Trismik
-API.
-
-Usage
------
-
-1. ```pip install trismik```
-2. Set the following environment variable. Alternatively, put it into `.env` file
-   in the root of your project, and load them using `python-dotenv` package:
-
-   ```
-   TRISMIK_API_KEY=<api_key>
-   ```
-
-3. Refer to examples:
-   * [example_runner.py](./examples/example_runner.py) - run test using high-level `TrismikRunner`
-     class
-   * [example_runner_async.py](./examples/example_runner_async.py) - like above, but with async
-     support
-   * [example_client.py](./examples/example_client.py) - run test using `TrismikClient` directly
-   * [example_client_async.py](./examples/example_client_async.py) - like above, but with async
-     support
-
-Contributing
-------------
-
-1. Install [Python Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
-2. ```git clone https://github.com/trismik/trismik-python.git```, or if cloned previously:
-   ```git pull``` to update
-3. ```cd ./trismik-python```
-4. ```poetry install```
-5. ```poetry run pytest```
-
-Publishing to TestPyPi
-----------------------
-
-1. ```poetry config repositories.testpypi https://test.pypi.org/legacy/```
-2. ```poetry config pypi-token.testpypi <token>```
-3. ```poetry publish --build --repository testpypi```
+Trismik Python SDK
+==================
+
+This is the official Python SDK for Trismik. It provides a simple way to interact with the Trismik
+API.
+
+Usage
+-----
+
+1. ```pip install trismik```
+2. Set the following environment variable. Alternatively, put it into `.env` file
+   in the root of your project, and load them using `python-dotenv` package:
+
+   ```
+   TRISMIK_API_KEY=<api_key>
+   ```
+
+3. Refer to examples:
+   * [example_runner.py](./examples/example_runner.py) - run test using high-level `TrismikRunner`
+     class
+   * [example_runner_async.py](./examples/example_runner_async.py) - like above, but with async
+     support
+   * [example_client.py](./examples/example_client.py) - run test using `TrismikClient` directly
+   * [example_client_async.py](./examples/example_client_async.py) - like above, but with async
+     support
+
+Contributing
+------------
+
+1. Install [Python Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
+2. ```git clone https://github.com/trismik/trismik-python.git```, or if cloned previously:
+   ```git pull``` to update
+3. ```cd ./trismik-python```
+4. ```poetry install```
+5. ```poetry run pytest```

{trismik-0.9.0 → trismik-0.9.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "trismik"
-version = "0.9.0"
+version = "0.9.1"
 description = ""
 authors = ["Bartosz Kielczewski <bk352@cam.ac.uk>"]
 readme = "README.md"

{trismik-0.9.0 → trismik-0.9.1}/src/trismik/__init__.py

@@ -1,20 +1,21 @@
-from .client import TrismikClient
-from .client_async import TrismikAsyncClient
-from .exceptions import (
-    TrismikError,
-    TrismikApiError
-)
-from .runner import TrismikRunner
-from .runner_async import TrismikAsyncRunner
-from .types import (
-    TrismikTest,
-    TrismikAuth,
-    TrismikSession,
-    TrismikItem,
-    TrismikMultipleChoiceTextItem,
-    TrismikChoice,
-    TrismikTextChoice,
-    TrismikResult,
-    TrismikResponse,
-    TrismikResultsAndResponses,
-)
+from .client import TrismikClient
+from .client_async import TrismikAsyncClient
+from .exceptions import (
+    TrismikError,
+    TrismikApiError
+)
+from .runner import TrismikRunner
+from .runner_async import TrismikAsyncRunner
+from .types import (
+    TrismikTest,
+    TrismikAuth,
+    TrismikSession,
+    TrismikItem,
+    TrismikMultipleChoiceTextItem,
+    TrismikChoice,
+    TrismikTextChoice,
+    TrismikResult,
+    TrismikResponse,
+    TrismikRunResults,
+    TrismikSessionMetadata,
+)

{trismik-0.9.0 → trismik-0.9.1}/src/trismik/_mapper.py

@@ -1,79 +1,79 @@
-from typing import List, Any
-
-from dateutil.parser import parse as parse_date
-
-from .exceptions import TrismikApiError
-from .types import (
-    TrismikItem,
-    TrismikResult,
-    TrismikMultipleChoiceTextItem,
-    TrismikTextChoice,
-    TrismikAuth,
-    TrismikTest,
-    TrismikSession,
-    TrismikResponse,
-)
-
-
-class TrismikResponseMapper:
-
-    @staticmethod
-    def to_auth(json: dict[str, Any]) -> TrismikAuth:
-        return TrismikAuth(
-                token=json["token"],
-                expires=parse_date(json["expires"]),
-        )
-
-    @staticmethod
-    def to_tests(json: List[dict[str, Any]]) -> List[TrismikTest]:
-        return [
-            TrismikTest(
-                    id=item["id"],
-                    name=item["name"],
-            ) for item in json
-        ]
-
-    @staticmethod
-    def to_session(json: dict[str, Any]) -> TrismikSession:
-        return TrismikSession(
-                id=json["id"],
-                url=json["url"],
-                status=json["status"],
-        )
-
-    @staticmethod
-    def to_item(json: dict[str, Any]) -> TrismikItem:
-        if json["type"] == "multiple_choice_text":
-            return TrismikMultipleChoiceTextItem(
-                    id=json["id"],
-                    question=json["question"],
-                    choices=[
-                        TrismikTextChoice(
-                                id=choice["id"],
-                                text=choice["text"],
-                        ) for choice in json["choices"]
-                    ]
-            )
-        else:
-            raise TrismikApiError(
-                    f"API has returned unrecognized item type: {json['type']}")
-
-    @staticmethod
-    def to_results(json: List[dict[str, Any]]) -> List[TrismikResult]:
-        return [
-            TrismikResult(
-                    trait=item["trait"],
-                    name=item["name"],
-                    value=item["value"],
-            ) for item in json
-        ]
-
-    @staticmethod
-    def to_responses(json: List[dict[str, Any]]) -> List[TrismikResponse]:
-        return [
-            TrismikResponse(
-                    item_id=response["itemId"],
-                    value=response["value"],
-                    score=response["score"],
-            ) for response in json
-        ]
+from typing import List, Any
+
+from dateutil.parser import parse as parse_date
+
+from .exceptions import TrismikApiError
+from .types import (
+    TrismikItem,
+    TrismikResult,
+    TrismikMultipleChoiceTextItem,
+    TrismikTextChoice,
+    TrismikAuth,
+    TrismikTest,
+    TrismikSession,
+    TrismikResponse,
+)
+
+
+class TrismikResponseMapper:
+
+    @staticmethod
+    def to_auth(json: dict[str, Any]) -> TrismikAuth:
+        return TrismikAuth(
+                token=json["token"],
+                expires=parse_date(json["expires"]),
+        )
+
+    @staticmethod
+    def to_tests(json: List[dict[str, Any]]) -> List[TrismikTest]:
+        return [
+            TrismikTest(
+                    id=item["id"],
+                    name=item["name"],
+            ) for item in json
+        ]
+
+    @staticmethod
+    def to_session(json: dict[str, Any]) -> TrismikSession:
+        return TrismikSession(
+                id=json["id"],
+                url=json["url"],
+                status=json["status"],
+        )
+
+    @staticmethod
+    def to_item(json: dict[str, Any]) -> TrismikItem:
+        if json["type"] == "multiple_choice_text":
+            return TrismikMultipleChoiceTextItem(
+                    id=json["id"],
+                    question=json["question"],
+                    choices=[
+                        TrismikTextChoice(
+                                id=choice["id"],
+                                text=choice["text"],
+                        ) for choice in json["choices"]
+                    ]
+            )
+        else:
+            raise TrismikApiError(
+                    f"API has returned unrecognized item type: {json['type']}")
+
+    @staticmethod
+    def to_results(json: List[dict[str, Any]]) -> List[TrismikResult]:
+        return [
+            TrismikResult(
+                    trait=item["trait"],
+                    name=item["name"],
+                    value=item["value"],
+            ) for item in json
+        ]
+
+    @staticmethod
+    def to_responses(json: List[dict[str, Any]]) -> List[TrismikResponse]:
+        return [
+            TrismikResponse(
+                    item_id=response["itemId"],
+                    value=response["value"],
+                    score=response["score"],
+            ) for response in json
+        ]

{trismik-0.9.0 → trismik-0.9.1}/src/trismik/_utils.py

@@ -1,44 +1,44 @@
-import os
-
-import httpx
-
-from .exceptions import TrismikError
-
-
-class TrismikUtils:
-
-    @staticmethod
-    def get_error_message(response: httpx.Response) -> str:
-        try:
-            return (response.json()).get("message", "Unknown error")
-        except (httpx.RequestError, ValueError):
-            error_message = response.content.decode("utf-8", errors="ignore")
-        return error_message
-
-    @staticmethod
-    def required_option(
-            value: str | None,
-            name: str,
-            env: str
-    ) -> str:
-        if value is None:
-            value = os.environ.get(env)
-        if value is None:
-            raise TrismikError(
-                    f"The {name} client option must be set either by passing "
-                    f"{env} to the client or by setting the {env} "
-                    "environment variable"
-            )
-        return value
-
-    @staticmethod
-    def option(
-            value: str | None,
-            default: str,
-            env: str,
-    ) -> str:
-        if value is None:
-            value = os.environ.get(env)
-        if value is None:
-            return default
-        return value
+import os
+
+import httpx
+
+from .exceptions import TrismikError
+
+
+class TrismikUtils:
+
+    @staticmethod
+    def get_error_message(response: httpx.Response) -> str:
+        try:
+            return (response.json()).get("message", "Unknown error")
+        except (httpx.RequestError, ValueError):
+            error_message = response.content.decode("utf-8", errors="ignore")
+        return error_message
+
+    @staticmethod
+    def required_option(
+            value: str | None,
+            name: str,
+            env: str
+    ) -> str:
+        if value is None:
+            value = os.environ.get(env)
+        if value is None:
+            raise TrismikError(
+                    f"The {name} client option must be set either by passing "
+                    f"{env} to the client or by setting the {env} "
+                    "environment variable"
+            )
+        return value
+
+    @staticmethod
+    def option(
+            value: str | None,
+            default: str,
+            env: str,
+    ) -> str:
+        if value is None:
+            value = os.environ.get(env)
+        if value is None:
+            return default
+        return value

{trismik-0.9.0 → trismik-0.9.1}/src/trismik/client.py

@@ -12,6 +12,7 @@ from .types import (
     TrismikItem,
     TrismikResult,
     TrismikResponse,
+    TrismikSessionMetadata
 )
 
 
@@ -120,7 +121,7 @@ class TrismikClient:
         except httpx.HTTPError as e:
             raise TrismikApiError(str(e)) from e
 
-    def create_session(self, test_id: str, token: str) -> TrismikSession:
+    def create_session(self, test_id: str, metadata: TrismikSessionMetadata, token: str) -> TrismikSession:
         """
         Creates a new session for a test.
 
@@ -137,7 +138,7 @@ class TrismikClient:
         try:
             url = "/client/sessions"
             headers = {"Authorization": f"Bearer {token}"}
-            body = {"testId": test_id, }
+            body = {"testId": test_id, "metadata": metadata.toDict() }
             response = self._http_client.post(url, headers=headers, json=body)
             response.raise_for_status()
             json = response.json()
@@ -147,6 +148,61 @@ class TrismikClient:
                     TrismikUtils.get_error_message(e.response)) from e
         except httpx.HTTPError as e:
             raise TrismikApiError(str(e)) from e
+        
+    def create_replay_session(self, previous_session_id: str, metadata: TrismikSessionMetadata, token: str) -> TrismikSession:
+        """
+        Creates a new session that replays exactly the question sequence of a previous session
+
+        Args:
+            previous_session_id (str): Session id of the session to replay.
+            token (str): Authentication token.
+
+        Returns:
+            TrismikSession: New session
+
+        Raises:
+            TrismikApiError: If API request fails.
+        """
+        try:
+            url = "/client/sessions/replay"
+            headers = {"Authorization": f"Bearer {token}"}
+            body = {"previousSessionToken": previous_session_id, "metadata": metadata.toDict(), }
+            response = self._http_client.post(url, headers=headers, json=body)
+            response.raise_for_status()
+            json = response.json()
+            return TrismikResponseMapper.to_session(json)
+        except httpx.HTTPStatusError as e:
+            raise TrismikApiError(
+                    TrismikUtils.get_error_message(e.response)) from e
+        except httpx.HTTPError as e:
+            raise TrismikApiError(str(e)) from e
+
+    def add_metadata(self, session_id: str, metadata: TrismikSessionMetadata, token: str) -> None:
+        """
+        Adds metadata to the session, merging it with any already stored
+
+        Args:
+            session_id (str): id of the session object
+            metadata: object cotaining the metadata to add
+            token (str): Authentication token.
+
+        Returns:
+            None
+
+        Raises:
+            TrismikApiError: If API request fails.
+        """
+        try:
+            url = f"/client/sessions/{session_id}/metadata"
+            headers = {"Authorization": f"Bearer {token}"}
+            body = metadata.toDict()
+            response = self._http_client.post(url, headers=headers, json=body)
+            response.raise_for_status()
+        except httpx.HTTPStatusError as e:
+            raise TrismikApiError(
+                    TrismikUtils.get_error_message(e.response)) from e
+        except httpx.HTTPError as e:
+            raise TrismikApiError(str(e)) from e
 
     def current_item(
             self,