eduskit 0.1.2__tar.gz

eduskit-0.1.2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Eduskit
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

eduskit-0.1.2/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: eduskit
+Version: 0.1.2
+Summary: Eduskit B-end server SDK for classroom and whiteboard APIs
+Author: Eduskit
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/eduskit/server-sdk-python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# eduskit
+
+Python B 端 Server SDK。`sdk.client` 调课堂 server-api，`sdk.whiteboard_client` 调白板 server-api。
+
+方法名为 snake_case；**请求/响应 JSON 字段仍为 camelCase**（`originId`、`eduUserId`）。
+
+概念与方法表见 [docs/overview.md](docs/overview.md)、[docs/api.md](docs/api.md)。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+要求 Python 3.9+，无第三方运行时依赖（标准库 `urllib`）。
+
+```bash
+PYTHONPATH=. python3 -m unittest tests.test_eduskit -v
+```
+
+## 初始化
+
+```python
+from eduskit import Eduskit, EduskitError
+
+sdk = Eduskit(
+    timeout_ms=10_000,
+    lang="zh-CN",
+    client={
+        "base_url": "http://localhost:3112",
+        "app_id": "app_edu",
+        "app_key": "edu_key",
+        "app_secret": "edu_secret",
+    },
+    whiteboard_client={
+        "base_url": "http://localhost:3012",
+        "app_id": "app_wb",
+        "app_key": "wb_key",
+        "app_secret": "wb_secret",
+    },
+)
+```
+
+配置字典键是 snake_case（`base_url` / `app_id` / `app_key` / `app_secret`）。两侧均可选。
+
+## 课堂 `sdk.client`
+
+```python
+user = sdk.client.users.register(
+    originId="stu_001",
+    nickname="小明",
+    avatar="https://example.com/a.png",
+)
+token = sdk.client.auth.issue_token(eduUserId=user["eduUserId"], originId="stu_001")
+classroom = sdk.client.classrooms.create(
+    name="一年级数学",
+    startsAt="2026-08-17T10:00:00.000Z",
+    endsAt="2026-08-17T11:00:00.000Z",
+    teacherEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.start(classroom["classroomId"])
+sdk.client.classrooms.members.add(
+    classroom["classroomId"],
+    eduUserId=user["eduUserId"],
+    role="student",
+)
+sdk.client.classrooms.members.replace_students(
+    classroom["classroomId"],
+    eduUserIds=[user["eduUserId"]],
+)
+sdk.client.classrooms.permissions.set(
+    classroom["classroomId"],
+    user["eduUserId"],
+    permission="camera",
+    effect="grant",
+    operatorEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.coursewares.bind(
+    classroom["classroomId"],
+    coursewareIds=["cw_xxx"],
+)
+sdk.client.app.get_ui_config()
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `users.register(**input)` | `users.register` |
+| `auth.issue_token(**input)` | `auth.issueToken` |
+| `classrooms.create/start/end` | 同名 |
+| `classrooms.members.add/list` | 同名 |
+| `classrooms.members.replace_students` | `replaceStudents` |
+| `classrooms.permissions.get/set/clear` | 同名 |
+| `classrooms.coursewares.list/bind/unbind` | 同名 |
+| `app.get_ui_config` / `set_ui_config` | `getUiConfig` / `setUiConfig` |
+
+## 白板 `sdk.whiteboard_client`
+
+```python
+credential = sdk.whiteboard_client.auth.issue_room_token(
+    roomId="room_1",
+    userId=user["eduUserId"],
+    role="host",
+    expiresIn=3600,
+)
+session = sdk.whiteboard_client.recordings.start("room_1", externalRef="lesson_001")
+sdk.whiteboard_client.recordings.stop("room_1", recordingId=session["recordingId"])
+sdk.whiteboard_client.recordings.enqueue_video_export(session["recordingId"], profile="hd")
+sdk.whiteboard_client.files.convert(sourceUrl="https://cdn.example.com/lesson.pptx")
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `auth.issue_room_token` | `issueRoomToken` |
+| `recordings.start/stop/list/get` | 同名 |
+| `recordings.register_media_asset` / `delete_media_asset` | camelCase 版 |
+| `recordings.enqueue_video_export` / `get_video_export` | camelCase 版 |
+| `captures.create/list` | 同名 |
+| `files.convert` / `get_convert_job` | `getConvertJob` |
+
+## 错误
+
+```python
+try:
+    sdk.client.auth.issue_token(eduUserId="")
+except EduskitError as e:
+    print(e.error_code, e.status, e.trace_id, e.source)
+```
+
+`sdk.client.last_trace_id` / `sdk.whiteboard_client.last_trace_id`。
+
+## 示例
+
+- [examples/classroom_quickstart.py](examples/classroom_quickstart.py)

eduskit-0.1.2/README.md

@@ -0,0 +1,133 @@
+# eduskit
+
+Python B 端 Server SDK。`sdk.client` 调课堂 server-api，`sdk.whiteboard_client` 调白板 server-api。
+
+方法名为 snake_case；**请求/响应 JSON 字段仍为 camelCase**（`originId`、`eduUserId`）。
+
+概念与方法表见 [docs/overview.md](docs/overview.md)、[docs/api.md](docs/api.md)。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+要求 Python 3.9+，无第三方运行时依赖（标准库 `urllib`）。
+
+```bash
+PYTHONPATH=. python3 -m unittest tests.test_eduskit -v
+```
+
+## 初始化
+
+```python
+from eduskit import Eduskit, EduskitError
+
+sdk = Eduskit(
+    timeout_ms=10_000,
+    lang="zh-CN",
+    client={
+        "base_url": "http://localhost:3112",
+        "app_id": "app_edu",
+        "app_key": "edu_key",
+        "app_secret": "edu_secret",
+    },
+    whiteboard_client={
+        "base_url": "http://localhost:3012",
+        "app_id": "app_wb",
+        "app_key": "wb_key",
+        "app_secret": "wb_secret",
+    },
+)
+```
+
+配置字典键是 snake_case（`base_url` / `app_id` / `app_key` / `app_secret`）。两侧均可选。
+
+## 课堂 `sdk.client`
+
+```python
+user = sdk.client.users.register(
+    originId="stu_001",
+    nickname="小明",
+    avatar="https://example.com/a.png",
+)
+token = sdk.client.auth.issue_token(eduUserId=user["eduUserId"], originId="stu_001")
+classroom = sdk.client.classrooms.create(
+    name="一年级数学",
+    startsAt="2026-08-17T10:00:00.000Z",
+    endsAt="2026-08-17T11:00:00.000Z",
+    teacherEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.start(classroom["classroomId"])
+sdk.client.classrooms.members.add(
+    classroom["classroomId"],
+    eduUserId=user["eduUserId"],
+    role="student",
+)
+sdk.client.classrooms.members.replace_students(
+    classroom["classroomId"],
+    eduUserIds=[user["eduUserId"]],
+)
+sdk.client.classrooms.permissions.set(
+    classroom["classroomId"],
+    user["eduUserId"],
+    permission="camera",
+    effect="grant",
+    operatorEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.coursewares.bind(
+    classroom["classroomId"],
+    coursewareIds=["cw_xxx"],
+)
+sdk.client.app.get_ui_config()
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `users.register(**input)` | `users.register` |
+| `auth.issue_token(**input)` | `auth.issueToken` |
+| `classrooms.create/start/end` | 同名 |
+| `classrooms.members.add/list` | 同名 |
+| `classrooms.members.replace_students` | `replaceStudents` |
+| `classrooms.permissions.get/set/clear` | 同名 |
+| `classrooms.coursewares.list/bind/unbind` | 同名 |
+| `app.get_ui_config` / `set_ui_config` | `getUiConfig` / `setUiConfig` |
+
+## 白板 `sdk.whiteboard_client`
+
+```python
+credential = sdk.whiteboard_client.auth.issue_room_token(
+    roomId="room_1",
+    userId=user["eduUserId"],
+    role="host",
+    expiresIn=3600,
+)
+session = sdk.whiteboard_client.recordings.start("room_1", externalRef="lesson_001")
+sdk.whiteboard_client.recordings.stop("room_1", recordingId=session["recordingId"])
+sdk.whiteboard_client.recordings.enqueue_video_export(session["recordingId"], profile="hd")
+sdk.whiteboard_client.files.convert(sourceUrl="https://cdn.example.com/lesson.pptx")
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `auth.issue_room_token` | `issueRoomToken` |
+| `recordings.start/stop/list/get` | 同名 |
+| `recordings.register_media_asset` / `delete_media_asset` | camelCase 版 |
+| `recordings.enqueue_video_export` / `get_video_export` | camelCase 版 |
+| `captures.create/list` | 同名 |
+| `files.convert` / `get_convert_job` | `getConvertJob` |
+
+## 错误
+
+```python
+try:
+    sdk.client.auth.issue_token(eduUserId="")
+except EduskitError as e:
+    print(e.error_code, e.status, e.trace_id, e.source)
+```
+
+`sdk.client.last_trace_id` / `sdk.whiteboard_client.last_trace_id`。
+
+## 示例
+
+- [examples/classroom_quickstart.py](examples/classroom_quickstart.py)

eduskit-0.1.2/eduskit/__init__.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from .classroom import ClassroomClient
+from .errors import EduskitError
+from .http import Fetcher, HttpTransport
+from .whiteboard import WhiteboardClient
+
+__all__ = [
+    "Eduskit",
+    "EduskitError",
+    "ClassroomClient",
+    "WhiteboardClient",
+]
+
+
+class Eduskit:
+    def __init__(
+        self,
+        *,
+        client: Optional[Dict[str, Any]] = None,
+        whiteboard_client: Optional[Dict[str, Any]] = None,
+        timeout_ms: int = 10_000,
+        lang: str = "zh-CN",
+        fetch: Optional[Fetcher] = None,
+    ) -> None:
+        self._client: Optional[ClassroomClient] = None
+        self._whiteboard: Optional[WhiteboardClient] = None
+        if client:
+            self._client = ClassroomClient(
+                HttpTransport(
+                    base_url=client["base_url"],
+                    app_key=client["app_key"],
+                    app_secret=client["app_secret"],
+                    timeout_ms=timeout_ms,
+                    lang=lang,
+                    source="classroom",
+                    fetch=fetch,
+                ),
+                app_id=client["app_id"],
+                app_secret=client["app_secret"],
+            )
+        if whiteboard_client:
+            self._whiteboard = WhiteboardClient(
+                HttpTransport(
+                    base_url=whiteboard_client["base_url"],
+                    app_key=whiteboard_client["app_key"],
+                    app_secret=whiteboard_client["app_secret"],
+                    timeout_ms=timeout_ms,
+                    lang=lang,
+                    source="whiteboard",
+                    fetch=fetch,
+                ),
+                app_id=whiteboard_client["app_id"],
+                app_secret=whiteboard_client["app_secret"],
+            )
+
+    @property
+    def client(self) -> ClassroomClient:
+        if self._client is None:
+            raise EduskitError(
+                "classroom client is not configured",
+                error_code="SDK_CLIENT_NOT_CONFIGURED",
+                source="classroom",
+            )
+        return self._client
+
+    @property
+    def whiteboard_client(self) -> WhiteboardClient:
+        if self._whiteboard is None:
+            raise EduskitError(
+                "whiteboard client is not configured",
+                error_code="SDK_CLIENT_NOT_CONFIGURED",
+                source="whiteboard",
+            )
+        return self._whiteboard

eduskit-0.1.2/eduskit/classroom.py

@@ -0,0 +1,149 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .http import HttpTransport
+from .token import iso_time, sign_hs256
+
+
+class _Users:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def register(self, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/users", input)
+
+
+class _Auth:
+    def __init__(self, app_id: str, app_secret: str) -> None:
+        self._app_id = app_id
+        self._app_secret = app_secret
+
+    def issue_token(self, **input: Any) -> Any:
+        user_id = input.get("eduUserId")
+        if not isinstance(user_id, str) or not user_id:
+            from .errors import EduskitError
+            raise EduskitError("eduUserId is required", error_code="SDK_TOKEN_INPUT_INVALID", source="classroom")
+        expires_in = input.get("expiresIn", 86400)
+        claims = {"appId": self._app_id}
+        if input.get("originId"):
+            claims["originId"] = input["originId"]
+        if input.get("role"):
+            claims["role"] = input["role"]
+        token, expires_at = sign_hs256(self._app_id, self._app_secret, user_id,
+            "eduskit-edu-auth", "eduskit-edu", expires_in, claims, "classroom")
+        return {"accessToken": token, "expiresIn": expires_in, "expiresAt": iso_time(expires_at),
+                "tokenType": "Bearer", "appId": self._app_id, "eduUserId": user_id,
+                "originId": input.get("originId", ""), "role": input.get("role", "")}
+
+
+class _Members:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def add(self, classroom_id: str, **input: Any) -> Any:
+        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/members", input)
+
+    def list(self, classroom_id: str) -> Any:
+        return self._http.request("GET", f"/v1/classrooms/{classroom_id}/members")
+
+    def replace_students(self, classroom_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "PUT",
+            f"/v1/classrooms/{classroom_id}/members/students",
+            input,
+        )
+
+
+class _Permissions:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def get(self, classroom_id: str, edu_user_id: str) -> Any:
+        return self._http.request(
+            "GET",
+            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions",
+        )
+
+    def set(self, classroom_id: str, edu_user_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions",
+            input,
+        )
+
+    def clear(
+        self,
+        classroom_id: str,
+        edu_user_id: str,
+        permission: str,
+        **input: Any,
+    ) -> Any:
+        return self._http.request(
+            "DELETE",
+            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions/{permission}",
+            input,
+        )
+
+
+class _Coursewares:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def list(self, classroom_id: str) -> Any:
+        return self._http.request("GET", f"/v1/classrooms/{classroom_id}/coursewares")
+
+    def bind(self, classroom_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            f"/v1/classrooms/{classroom_id}/coursewares",
+            input,
+        )
+
+    def unbind(self, classroom_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "DELETE",
+            f"/v1/classrooms/{classroom_id}/coursewares",
+            input,
+        )
+
+
+class _Classrooms:
+    def __init__(self, http: HttpTransport) -> None:
+        self.members = _Members(http)
+        self.permissions = _Permissions(http)
+        self.coursewares = _Coursewares(http)
+        self._http = http
+
+    def create(self, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/classrooms", input)
+
+    def start(self, classroom_id: str) -> Any:
+        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/start")
+
+    def end(self, classroom_id: str) -> Any:
+        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/end")
+
+
+class _App:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def get_ui_config(self) -> Any:
+        return self._http.request("GET", "/v1/app/ui-config")
+
+    def set_ui_config(self, **input: Any) -> Any:
+        return self._http.request("PUT", "/v1/app/ui-config", input)
+
+
+class ClassroomClient:
+    def __init__(self, http: HttpTransport, *, app_id: str, app_secret: str) -> None:
+        self.users = _Users(http)
+        self.auth = _Auth(app_id, app_secret)
+        self.classrooms = _Classrooms(http)
+        self.app = _App(http)
+        self._http = http
+
+    @property
+    def last_trace_id(self) -> str:
+        return self._http.last_trace_id

eduskit-0.1.2/eduskit/errors.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typing import Optional
+
+
+class EduskitError(Exception):
+    def __init__(
+        self,
+        message: str,
+        status: Optional[int] = None,
+        error_code: Optional[str] = None,
+        trace_id: Optional[str] = None,
+        path: Optional[str] = None,
+        source: Optional[str] = None,
+    ) -> None:
+        super().__init__(message)
+        self.status = status
+        self.error_code = error_code
+        self.trace_id = trace_id
+        self.path = path
+        self.source = source

eduskit-0.1.2/eduskit/http.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import json
+import uuid
+from typing import Any, Callable, Dict, Optional, Tuple
+from urllib.error import HTTPError, URLError
+from urllib.request import Request, urlopen
+
+from .errors import EduskitError
+
+Fetcher = Callable[[str, str, Dict[str, str], Optional[bytes], int], Tuple[int, Dict[str, str], bytes]]
+
+
+def _default_fetch(
+    url: str,
+    method: str,
+    headers: dict[str, str],
+    body: bytes | None,
+    timeout_ms: int,
+) -> tuple[int, dict[str, str], bytes]:
+    request = Request(url, data=body, method=method, headers=headers)
+    try:
+        with urlopen(request, timeout=timeout_ms / 1000) as response:
+            return response.status, dict(response.headers.items()), response.read()
+    except HTTPError as error:
+        return error.code, dict(error.headers.items()), error.read()
+
+
+class HttpTransport:
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        app_key: str,
+        app_secret: str,
+        timeout_ms: int = 10_000,
+        lang: str = "zh-CN",
+        source: str,
+        fetch: Optional[Fetcher] = None,
+    ) -> None:
+        self.base_url = base_url.rstrip("/")
+        self.app_key = app_key
+        self.app_secret = app_secret
+        self.timeout_ms = timeout_ms
+        self.lang = lang
+        self.source = source
+        self.fetch = fetch or _default_fetch
+        self.last_trace_id = ""
+
+    def request(self, method: str, path: str, body: Optional[Any] = None) -> Any:
+        trace_id = uuid.uuid4().hex[:16]
+        payload = None if body is None else json.dumps(body).encode("utf-8")
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "x-app-key": self.app_key,
+            "x-app-secret": self.app_secret,
+            "x-lang": self.lang,
+            "x-trace-id": trace_id,
+        }
+        try:
+            status, response_headers, raw = self.fetch(
+                f"{self.base_url}{path}",
+                method,
+                headers,
+                payload,
+                self.timeout_ms,
+            )
+        except URLError as error:
+            raise EduskitError(
+                str(error.reason),
+                error_code="SDK_NETWORK_ERROR",
+                path=path,
+                source=self.source,
+                trace_id=trace_id,
+            ) from error
+
+        text = raw.decode("utf-8") if raw else ""
+        data: dict[str, Any] = {}
+        if text:
+            try:
+                parsed = json.loads(text)
+            except json.JSONDecodeError as error:
+                raise EduskitError(
+                    text or f"invalid json (HTTP {status})",
+                    status=status,
+                    error_code="SDK_INVALID_JSON",
+                    path=path,
+                    source=self.source,
+                    trace_id=trace_id,
+                ) from error
+            if isinstance(parsed, dict):
+                data = parsed
+            else:
+                data = {"data": parsed}
+
+        header_trace = ""
+        for key, value in response_headers.items():
+            if key.lower() == "x-trace-id":
+                header_trace = value
+                break
+        self.last_trace_id = str(data.get("traceId") or header_trace or trace_id)
+
+        code = data.get("code")
+        if status >= 400 or (code is not None and code != 0):
+            raise EduskitError(
+                str(data.get("message") or f"HTTP {status}"),
+                status=status,
+                error_code=str(data.get("errorCode") or f"HTTP_{status}"),
+                path=str(data.get("path") or path),
+                source=self.source,
+                trace_id=self.last_trace_id,
+            )
+        if "data" in data:
+            return data["data"]
+        return data

eduskit-0.1.2/eduskit/token.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+import base64
+import hashlib
+import hmac
+import json
+import time
+from datetime import datetime, timezone
+from typing import Any, Dict
+
+from .errors import EduskitError
+
+
+def sign_hs256(app_id: str, app_secret: str, subject: str, issuer: str,
+               audience: str, expires_in: int, claims: Dict[str, Any],
+               source: str) -> tuple[str, int]:
+    if not app_id or not app_secret or not subject:
+        raise _error("app_id, app_secret and subject are required", source)
+    if not isinstance(expires_in, int) or expires_in < 60 or expires_in > 604800:
+        raise _error("expiresIn must be an integer between 60 and 604800", source)
+    issued_at = int(time.time())
+    expires_at = issued_at + expires_in
+    header = _encode({"alg": "HS256", "typ": "JWT"})
+    payload = _encode({**claims, "iss": issuer, "aud": audience,
+                       "sub": subject, "iat": issued_at, "exp": expires_at})
+    content = f"{header}.{payload}"
+    signature = _b64(hmac.new(app_secret.encode(), content.encode(), hashlib.sha256).digest())
+    return f"{content}.{signature}", expires_at
+
+
+def iso_time(seconds: int) -> str:
+    return datetime.fromtimestamp(seconds, timezone.utc).isoformat(timespec="milliseconds").replace("+00:00", "Z")
+
+
+def _encode(value: Any) -> str:
+    return _b64(json.dumps(value, separators=(",", ":"), ensure_ascii=False).encode())
+
+
+def _b64(value: bytes) -> str:
+    return base64.urlsafe_b64encode(value).decode().rstrip("=")
+
+
+def _error(message: str, source: str) -> EduskitError:
+    return EduskitError(message, error_code="SDK_TOKEN_INPUT_INVALID", source=source)

eduskit-0.1.2/eduskit/whiteboard.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .http import HttpTransport
+from .errors import EduskitError
+from .token import iso_time, sign_hs256
+
+
+class _Auth:
+    def __init__(self, app_id: str, app_secret: str) -> None:
+        self._app_id = app_id
+        self._app_secret = app_secret
+
+    def issue_room_token(self, **input: Any) -> Any:
+        room_id, user_id, role = input.get("roomId"), input.get("userId"), input.get("role")
+        if not room_id or not user_id or role not in ("host", "participant", "observer"):
+            raise EduskitError("roomId, userId and a valid role are required", error_code="SDK_TOKEN_INPUT_INVALID", source="whiteboard")
+        expires_in = input.get("expiresIn", 3600)
+        token, expires_at = sign_hs256(self._app_id, self._app_secret, user_id,
+            "eduskit", "eduskit-room", expires_in,
+            {"app_id": self._app_id, "room_id": room_id, "role": role, "source": "server_sdk"},
+            "whiteboard")
+        return {"token": token, "appId": self._app_id, "roomId": room_id, "userId": user_id,
+                "role": role, "expiresIn": expires_in, "expiresAt": iso_time(expires_at)}
+
+
+class _Recordings:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def start(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", f"/v1/rooms/{room_id}/recording/start", input)
+
+    def stop(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", f"/v1/rooms/{room_id}/recording/stop", input)
+
+    def list(self, room_id: str) -> Any:
+        return self._http.request("GET", f"/v1/rooms/{room_id}/recordings")
+
+    def get(self, recording_id: str) -> Any:
+        return self._http.request("GET", f"/v1/recordings/{recording_id}")
+
+    def register_media_asset(self, recording_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            f"/v1/recordings/{recording_id}/media-assets",
+            input,
+        )
+
+    def delete_media_asset(self, recording_id: str, asset_id: str) -> Any:
+        return self._http.request(
+            "DELETE",
+            f"/v1/recordings/{recording_id}/media-assets/{asset_id}",
+        )
+
+    def enqueue_video_export(self, recording_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            f"/v1/recordings/{recording_id}/video-exports",
+            input,
+        )
+
+    def get_video_export(self, recording_id: str, job_id: str) -> Any:
+        return self._http.request(
+            "GET",
+            f"/v1/recordings/{recording_id}/video-exports/{job_id}",
+        )
+
+
+class _Captures:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def create(self, room_id: str, **input: Any) -> Any:
+        body = {"roomId": room_id, **input}
+        return self._http.request("POST", f"/v1/rooms/{room_id}/captures", body)
+
+    def list(self, room_id: str) -> Any:
+        return self._http.request("GET", f"/v1/rooms/{room_id}/captures")
+
+
+class _Files:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def convert(self, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/files/convert", input)
+
+    def get_convert_job(self, job_id: str) -> Any:
+        return self._http.request("GET", f"/v1/files/convert/{job_id}")
+
+
+class WhiteboardClient:
+    def __init__(self, http: HttpTransport, *, app_id: str, app_secret: str) -> None:
+        self.auth = _Auth(app_id, app_secret)
+        self.recordings = _Recordings(http)
+        self.captures = _Captures(http)
+        self.files = _Files(http)
+        self._http = http
+
+    @property
+    def last_trace_id(self) -> str:
+        return self._http.last_trace_id

eduskit-0.1.2/eduskit.egg-info/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: eduskit
+Version: 0.1.2
+Summary: Eduskit B-end server SDK for classroom and whiteboard APIs
+Author: Eduskit
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/eduskit/server-sdk-python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# eduskit
+
+Python B 端 Server SDK。`sdk.client` 调课堂 server-api，`sdk.whiteboard_client` 调白板 server-api。
+
+方法名为 snake_case；**请求/响应 JSON 字段仍为 camelCase**（`originId`、`eduUserId`）。
+
+概念与方法表见 [docs/overview.md](docs/overview.md)、[docs/api.md](docs/api.md)。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+要求 Python 3.9+，无第三方运行时依赖（标准库 `urllib`）。
+
+```bash
+PYTHONPATH=. python3 -m unittest tests.test_eduskit -v
+```
+
+## 初始化
+
+```python
+from eduskit import Eduskit, EduskitError
+
+sdk = Eduskit(
+    timeout_ms=10_000,
+    lang="zh-CN",
+    client={
+        "base_url": "http://localhost:3112",
+        "app_id": "app_edu",
+        "app_key": "edu_key",
+        "app_secret": "edu_secret",
+    },
+    whiteboard_client={
+        "base_url": "http://localhost:3012",
+        "app_id": "app_wb",
+        "app_key": "wb_key",
+        "app_secret": "wb_secret",
+    },
+)
+```
+
+配置字典键是 snake_case（`base_url` / `app_id` / `app_key` / `app_secret`）。两侧均可选。
+
+## 课堂 `sdk.client`
+
+```python
+user = sdk.client.users.register(
+    originId="stu_001",
+    nickname="小明",
+    avatar="https://example.com/a.png",
+)
+token = sdk.client.auth.issue_token(eduUserId=user["eduUserId"], originId="stu_001")
+classroom = sdk.client.classrooms.create(
+    name="一年级数学",
+    startsAt="2026-08-17T10:00:00.000Z",
+    endsAt="2026-08-17T11:00:00.000Z",
+    teacherEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.start(classroom["classroomId"])
+sdk.client.classrooms.members.add(
+    classroom["classroomId"],
+    eduUserId=user["eduUserId"],
+    role="student",
+)
+sdk.client.classrooms.members.replace_students(
+    classroom["classroomId"],
+    eduUserIds=[user["eduUserId"]],
+)
+sdk.client.classrooms.permissions.set(
+    classroom["classroomId"],
+    user["eduUserId"],
+    permission="camera",
+    effect="grant",
+    operatorEduUserId=user["eduUserId"],
+)
+sdk.client.classrooms.coursewares.bind(
+    classroom["classroomId"],
+    coursewareIds=["cw_xxx"],
+)
+sdk.client.app.get_ui_config()
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `users.register(**input)` | `users.register` |
+| `auth.issue_token(**input)` | `auth.issueToken` |
+| `classrooms.create/start/end` | 同名 |
+| `classrooms.members.add/list` | 同名 |
+| `classrooms.members.replace_students` | `replaceStudents` |
+| `classrooms.permissions.get/set/clear` | 同名 |
+| `classrooms.coursewares.list/bind/unbind` | 同名 |
+| `app.get_ui_config` / `set_ui_config` | `getUiConfig` / `setUiConfig` |
+
+## 白板 `sdk.whiteboard_client`
+
+```python
+credential = sdk.whiteboard_client.auth.issue_room_token(
+    roomId="room_1",
+    userId=user["eduUserId"],
+    role="host",
+    expiresIn=3600,
+)
+session = sdk.whiteboard_client.recordings.start("room_1", externalRef="lesson_001")
+sdk.whiteboard_client.recordings.stop("room_1", recordingId=session["recordingId"])
+sdk.whiteboard_client.recordings.enqueue_video_export(session["recordingId"], profile="hd")
+sdk.whiteboard_client.files.convert(sourceUrl="https://cdn.example.com/lesson.pptx")
+```
+
+| 方法 | 对应 Node |
+|------|-----------|
+| `auth.issue_room_token` | `issueRoomToken` |
+| `recordings.start/stop/list/get` | 同名 |
+| `recordings.register_media_asset` / `delete_media_asset` | camelCase 版 |
+| `recordings.enqueue_video_export` / `get_video_export` | camelCase 版 |
+| `captures.create/list` | 同名 |
+| `files.convert` / `get_convert_job` | `getConvertJob` |
+
+## 错误
+
+```python
+try:
+    sdk.client.auth.issue_token(eduUserId="")
+except EduskitError as e:
+    print(e.error_code, e.status, e.trace_id, e.source)
+```
+
+`sdk.client.last_trace_id` / `sdk.whiteboard_client.last_trace_id`。
+
+## 示例
+
+- [examples/classroom_quickstart.py](examples/classroom_quickstart.py)

eduskit-0.1.2/eduskit.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+eduskit/__init__.py
+eduskit/classroom.py
+eduskit/errors.py
+eduskit/http.py
+eduskit/token.py
+eduskit/whiteboard.py
+eduskit.egg-info/PKG-INFO
+eduskit.egg-info/SOURCES.txt
+eduskit.egg-info/dependency_links.txt
+eduskit.egg-info/top_level.txt
+tests/test_eduskit.py

eduskit-0.1.2/eduskit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

eduskit-0.1.2/eduskit.egg-info/top_level.txt

@@ -0,0 +1 @@
+eduskit

eduskit-0.1.2/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "eduskit"
+version = "0.1.2"
+description = "Eduskit B-end server SDK for classroom and whiteboard APIs"
+requires-python = ">=3.9"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Eduskit" }]
+classifiers = ["Programming Language :: Python :: 3"]
+urls = { Repository = "https://github.com/eduskit/server-sdk-python" }
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["eduskit*"]

eduskit-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

eduskit-0.1.2/tests/test_eduskit.py

@@ -0,0 +1,89 @@
+import json
+import unittest
+
+from eduskit import Eduskit, EduskitError
+
+
+def mock_fetch(body, status=200, headers=None):
+    calls = []
+
+    def fetch(url, method, req_headers, payload, timeout_ms):
+        calls.append(
+            {
+                "url": url,
+                "method": method,
+                "headers": req_headers,
+                "body": json.loads(payload.decode()) if payload else None,
+            }
+        )
+        return status, headers or {"x-trace-id": "wb-trace"}, json.dumps(body).encode()
+
+    return fetch, calls
+
+
+class EduskitTest(unittest.TestCase):
+    def test_classroom_register(self):
+        fetch, calls = mock_fetch(
+            {
+                "code": 0,
+                "data": {"eduUserId": "eu_1", "nickname": "n"},
+                "traceId": "body-trace",
+            }
+        )
+        sdk = Eduskit(
+            client={"base_url": "http://edu.test", "app_id": "app_edu", "app_key": "k", "app_secret": "secret-edu"},
+            fetch=fetch,
+        )
+        user = sdk.client.users.register(nickname="n", avatar="https://a")
+        self.assertEqual(user["eduUserId"], "eu_1")
+        self.assertEqual(sdk.client.last_trace_id, "body-trace")
+        self.assertEqual(calls[0]["url"], "http://edu.test/v1/users")
+        self.assertEqual(calls[0]["headers"]["x-app-key"], "k")
+
+    def test_whiteboard_issue_room_token(self):
+        fetch, calls = mock_fetch({"code": 0, "data": {"token": "rt"}})
+        sdk = Eduskit(
+            whiteboard_client={
+                "base_url": "http://wb.test",
+                "app_id": "app_wb",
+                "app_key": "wk",
+                "app_secret": "ws",
+            },
+            fetch=fetch,
+        )
+        token = sdk.whiteboard_client.auth.issue_room_token(
+            roomId="r1", userId="u1", role="host"
+        )
+        self.assertEqual(token["appId"], "app_wb")
+        self.assertEqual(len(token["token"].split(".")), 3)
+        self.assertEqual(calls, [])
+
+    def test_error_envelope(self):
+        fetch, _ = mock_fetch(
+            {
+                "code": 404,
+                "errorCode": "EDU_USER_NOT_FOUND",
+                "message": "missing",
+                "traceId": "err",
+            },
+            status=404,
+        )
+        sdk = Eduskit(
+            client={"base_url": "http://edu.test", "app_id": "app_edu", "app_key": "k", "app_secret": "secret-edu"},
+            fetch=fetch,
+        )
+        with self.assertRaises(EduskitError) as ctx:
+            sdk.client.auth.issue_token(eduUserId="")
+        self.assertEqual(ctx.exception.error_code, "SDK_TOKEN_INPUT_INVALID")
+
+    def test_unconfigured(self):
+        sdk = Eduskit(
+            client={"base_url": "http://edu.test", "app_id": "app_edu", "app_key": "k", "app_secret": "secret-edu"}
+        )
+        with self.assertRaises(EduskitError) as ctx:
+            _ = sdk.whiteboard_client
+        self.assertEqual(ctx.exception.error_code, "SDK_CLIENT_NOT_CONFIGURED")
+
+
+if __name__ == "__main__":
+    unittest.main()