PyHiveLMS 5.12.0__py3-none-any.whl

pyhive/src/types/user.py

@@ -0,0 +1,375 @@
+"""Hive management course user type."""
+
+import datetime
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, Self, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field
+from dateutil.parser import isoparse
+from src.types.common import UNSET, Unset
+from src.types.core_item import HiveCoreItem
+from src.types.enums.clearance_enum import ClearanceEnum
+from src.types.enums.gender_enum import GenderEnum
+from src.types.enums.status_enum import StatusEnum
+
+if TYPE_CHECKING:
+    from client import HiveClient
+    from src.types.assignment import Assignment
+    from src.types.class_ import Class
+    from src.types.program import Program
+    from src.types.queue import Queue
+
+T = TypeVar("T", bound="User")
+
+
+@_attrs_define
+class User(HiveCoreItem):  # pylint: disable=too-many-instance-attributes
+    """Hive management course user.
+
+    Attributes:
+    id (int):
+    display_name (str):
+    clearance (ClearanceEnum):
+        * `1` - Hanich
+        * `2` - Checker
+        * `3` - Segel
+        * `5` - Admin
+    gender (GenderEnum):
+        * `Male` - Male
+        * `Female` - Female
+        * `NonBinary` - Nonbinary
+    current_assignment (Union[None, int]):
+    current_assignment_options (list[int]):
+    mentees (list[int]):
+    username (str): Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+    status (StatusEnum):
+        * `Present` - Present
+        * `Raised Hand` - Raisedhand
+        * `Toilet Request` - Toiletrequest
+        * `Toilet` - Toilet
+        * `Personal Talk` - Personaltalk
+        * `Work Talk` - Worktalk
+        * `Medical` - Medical
+        * `Prayer` - Prayer
+        * `Room` - Room
+        * `Home` - Home
+    status_date (datetime.datetime):
+    avatar_filename (Union[Unset, str]):
+    number (Union[None, Unset, int]):
+    program (Union[None, Unset, int]):
+    checkers_brief (Union[Unset, str]):
+    mentor (Union[None, Unset, int]):
+    classes (Union[Unset, list[int]]):
+    first_name (Union[Unset, str]):
+    last_name (Union[Unset, str]):
+    queue (Union[None, Unset, int]):
+    disable_queue (Union[Unset, bool]):
+    user_queue (Union[None, Unset, int]):
+    disable_user_queue (Union[Unset, bool]):
+    override_queue (Union[None, Unset, int]):
+    confirmed (Union[Unset, bool]):
+    teacher (Union[Unset, bool]):
+    hostname (Union[Unset, str]):
+
+    """
+
+    hive_client: "HiveClient"
+    id: int
+    display_name: str
+    clearance: ClearanceEnum
+    gender: GenderEnum
+    current_assignment_id: None | int
+    _current_assignment: "Assignment | None" = field(init=False, default=None)
+    current_assignment_options: list[int]
+    mentee_ids: list[int]
+    _mentees: "list[User] | None" = field(init=False, default=None)
+    username: str
+    status: StatusEnum
+    status_date: datetime.datetime
+    avatar_filename: Unset | str = UNSET
+    number: None | Unset | int = UNSET
+    program_id: None | Unset | int = UNSET
+    _program: "Program | None" = field(init=False, default=None)
+    checkers_brief: Unset | str = UNSET
+    mentor_id: None | Unset | int = UNSET
+    _mentor: "User | None" = field(init=False, default=None)
+    class_ids: Unset | list[int] = UNSET
+    _classes: "list[Class] | None" = field(init=False, default=None)
+    first_name: Unset | str = UNSET
+    last_name: Unset | str = UNSET
+    queue_id: None | Unset | int = UNSET
+    _queue: "Queue | None" = field(init=False, default=None)
+    disable_queue: Unset | bool = UNSET
+    user_queue_id: None | Unset | int = UNSET
+    _user_queue: "Queue | None" = field(init=False, default=None)
+    disable_user_queue: Unset | bool = UNSET
+    override_queue_id: None | Unset | int = UNSET
+    _override_queue: "Queue | None" = field(init=False, default=None)
+    confirmed: Unset | bool = UNSET
+    teacher: Unset | bool = UNSET
+    hostname: Unset | str = UNSET
+
+    def to_dict(  # pylint: disable=too-many-locals, too-many-statements, too-many-branches
+        self,
+    ) -> dict[str, Any]:
+        id = self.id
+
+        display_name = self.display_name
+
+        clearance = self.clearance.value
+
+        gender = self.gender.value
+
+        current_assignment_id: None | int
+        current_assignment_id = self.current_assignment_id
+
+        current_assignment_options = self.current_assignment_options
+
+        mentee_ids = self.mentee_ids
+
+        username = self.username
+
+        status = self.status.value
+
+        status_date = self.status_date.isoformat()
+
+        avatar_filename = self.avatar_filename
+
+        number: None | Unset | int
+        number = UNSET if isinstance(self.number, Unset) else self.number
+
+        program_id: None | Unset | int
+        program_id = UNSET if isinstance(self.program_id, Unset) else self.program_id
+
+        checkers_brief = self.checkers_brief
+
+        mentor_id: None | Unset | int
+        mentor_id = UNSET if isinstance(self.mentor_id, Unset) else self.mentor_id
+
+        class_ids: Unset | list[int] = UNSET
+        if not isinstance(self.class_ids, Unset):
+            class_ids = self.class_ids
+
+        first_name = self.first_name
+
+        last_name = self.last_name
+
+        queue_id: None | Unset | int
+        queue_id = UNSET if isinstance(self.queue_id, Unset) else self.queue_id
+
+        disable_queue = self.disable_queue
+
+        user_queue_id: None | Unset | int
+        user_queue_id = (
+            UNSET if isinstance(self.user_queue_id, Unset) else self.user_queue_id
+        )
+
+        disable_user_queue = self.disable_user_queue
+
+        override_queue_id: None | Unset | int
+        override_queue_id = (
+            UNSET
+            if isinstance(self.override_queue_id, Unset)
+            else self.override_queue_id
+        )
+
+        confirmed = self.confirmed
+
+        teacher = self.teacher
+
+        hostname = self.hostname
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(
+            {
+                "id": id,
+                "display_name": display_name,
+                "clearance": clearance,
+                "gender": gender,
+                "current_assignment": current_assignment_id,
+                "current_assignment_options": current_assignment_options,
+                "mentees": mentee_ids,
+                "username": username,
+                "status": status,
+                "status_date": status_date,
+            },
+        )
+        if avatar_filename is not UNSET:
+            field_dict["avatar_filename"] = avatar_filename
+        if number is not UNSET:
+            field_dict["number"] = number
+        if program_id is not UNSET:
+            field_dict["program"] = program_id
+        if checkers_brief is not UNSET:
+            field_dict["checkers_brief"] = checkers_brief
+        if mentor_id is not UNSET:
+            field_dict["mentor"] = mentor_id
+        if class_ids is not UNSET:
+            field_dict["classes"] = class_ids
+        if first_name is not UNSET:
+            field_dict["first_name"] = first_name
+        if last_name is not UNSET:
+            field_dict["last_name"] = last_name
+        if queue_id is not UNSET:
+            field_dict["queue"] = queue_id
+        if disable_queue is not UNSET:
+            field_dict["disable_queue"] = disable_queue
+        if user_queue_id is not UNSET:
+            field_dict["user_queue"] = user_queue_id
+        if disable_user_queue is not UNSET:
+            field_dict["disable_user_queue"] = disable_user_queue
+        if override_queue_id is not UNSET:
+            field_dict["override_queue"] = override_queue_id
+        if confirmed is not UNSET:
+            field_dict["confirmed"] = confirmed
+        if teacher is not UNSET:
+            field_dict["teacher"] = teacher
+        if hostname is not UNSET:
+            field_dict["hostname"] = hostname
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls, src_dict: Mapping[str, Any], hive_client: "HiveClient") -> Self: # pylint: disable=too-many-locals
+        """Deserialize a User instance from a mapping."""
+        d = dict(src_dict)
+        id = d.pop("id")
+
+        display_name = d.pop("display_name")
+
+        clearance = ClearanceEnum(d.pop("clearance"))
+
+        gender = GenderEnum(d.pop("gender"))
+
+        def _parse_current_assignment(data: object) -> None | int:
+            if data is None:
+                return data
+            return cast("None | int", data)
+
+        current_assignment = _parse_current_assignment(d.pop("current_assignment"))
+
+        current_assignment_options = cast(
+            "list[int]", d.pop("current_assignment_options")
+        )
+
+        mentees = cast("list[int]", d.pop("mentees"))
+
+        username = d.pop("username")
+
+        status = StatusEnum(d.pop("status"))
+
+        status_date = isoparse(d.pop("status_date"))
+
+        avatar_filename = d.pop("avatar_filename", UNSET)
+
+        def _parse_number(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        number = _parse_number(d.pop("number", UNSET))
+
+        def _parse_program(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        program = _parse_program(d.pop("program", UNSET))
+
+        checkers_brief = d.pop("checkers_brief", UNSET)
+
+        def _parse_mentor(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        mentor = _parse_mentor(d.pop("mentor", UNSET))
+
+        classes = cast("list[int]", d.pop("classes", UNSET))
+
+        first_name = d.pop("first_name", UNSET)
+
+        last_name = d.pop("last_name", UNSET)
+
+        def _parse_queue(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        queue = _parse_queue(d.pop("queue", UNSET))
+
+        disable_queue = d.pop("disable_queue", UNSET)
+
+        def _parse_user_queue(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        user_queue = _parse_user_queue(d.pop("user_queue", UNSET))
+
+        disable_user_queue = d.pop("disable_user_queue", UNSET)
+
+        def _parse_override_queue(data: object) -> None | Unset | int:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast("None | Unset | int", data)
+
+        override_queue = _parse_override_queue(d.pop("override_queue", UNSET))
+
+        confirmed = d.pop("confirmed", UNSET)
+
+        teacher = d.pop("teacher", UNSET)
+
+        hostname = d.pop("hostname", UNSET)
+
+        return cls(
+            id=id,
+            display_name=display_name,
+            clearance=clearance,
+            gender=gender,
+            current_assignment_id=current_assignment,
+            current_assignment_options=current_assignment_options,
+            mentee_ids=mentees,
+            username=username,
+            status=status,
+            status_date=status_date,
+            avatar_filename=avatar_filename,
+            number=number,
+            program_id=program,
+            checkers_brief=checkers_brief,
+            mentor_id=mentor,
+            class_ids=classes,
+            first_name=first_name,
+            last_name=last_name,
+            queue_id=queue,
+            disable_queue=disable_queue,
+            user_queue_id=user_queue,
+            disable_user_queue=disable_user_queue,
+            override_queue_id=override_queue,
+            confirmed=confirmed,
+            teacher=teacher,
+            hostname=hostname,
+            hive_client=hive_client,
+        )
+
+    @property
+    def program(self) -> "Program | None":
+        """The program this user is in."""
+        if not isinstance(self.program_id, int):
+            return None
+        if self._program is None:
+            self._program = self.hive_client.get_program(self.program_id)
+        return self._program

pyhivelms-5.12.0.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: PyHiveLMS
+Version: 5.12.0
+Summary: Python bindings for Hive
+Author-email: "Michael K. Steinberg" <m.kuper.steinberg@gmail.com>
+Requires-Python: >=3.11.0
+Requires-Dist: httpx
+Description-Content-Type: text/markdown
+
+
+# pyhive — a stupid simple Hive Python API
+
+Lightweight, no-fuss Python client for the Hive service used in this repo. It exposes a small, synchronous HTTP client (as a context manager) and typed model objects for common Hive resources like programs, subjects, modules, exercises and users.
+
+## Highlights
+- Minimal, dependency-light wrapper around the Hive API
+- Generator-based list endpoints for memory-efficient iteration
+- Typed model objects under `src.types` for convenience
+
+## Install
+This project uses plain Python. From the repository root you can install the development requirements or install the package locally.
+
+1) Create and activate a virtualenv (recommended)
+
+Windows (PowerShell):
+
+```pwsh
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+```
+
+2) Install dependencies
+
+```pwsh
+pip install -r requirements.txt
+# or install the package in editable mode
+pip install -e .
+```
+
+## Quickstart
+The main client class is `HiveClient` in `pyhive.client`. It is used as a context manager to ensure proper session/login handling.
+
+Example — list programs and print their ids and names:
+
+```python
+from pyhive.client import HiveClient
+
+USERNAME = "yourusername"
+PASSWORD = "yourpassword"
+HIVE_URL = "https://hive.example.com"
+
+with HiveClient(USERNAME, PASSWORD, HIVE_URL) as client:
+	for program in client.get_course_programs():
+		print(program.id, program.name)
+```
+
+Example — fetch a program by id:
+
+```python
+with HiveClient(USERNAME, PASSWORD, HIVE_URL) as client:
+	program = client.get_program(42)
+	print(program.name, program.description)
+```
+
+Notes on generators: list-style endpoints (e.g. `get_course_programs`, `get_exercises`, `get_users`, `get_classes`) return generators of typed model objects — iterate over them or convert to a list if you need random access.
+
+## API contract (short)
+- Initialization: `HiveClient(username: str, password: str, hive_url: str, **kwargs)`
+- Common methods return either a single typed object (e.g. `get_program(id)`) or a generator of objects (e.g. `get_course_programs()`)
+- Model classes provide `.from_dict(...)` constructors and are found under `src.types`.
+
+Error handling: HTTP-level errors raised by the underlying request logic will surface; catch exceptions around client calls as needed.
+
+## Tests
+Run the unit tests with pytest from the repository root:
+
+```pwsh
+pip install -r requirements.txt
+pytest -q
+```
+
+## Contributing
+- Open an issue or PR for changes
+- Keep changes focused and small; prefer adding tests for new behavior
+
+## Files of interest
+- `pyhive/client.py` — the high-level client class you will use
+- `src/types/` — typed model objects created from API responses
+- `tests/` — unit tests and examples of client usage
+
+## License
+This repository does not include a formal license file. Add a LICENSE if you plan to publish or share this package.

pyhivelms-5.12.0.dist-info/RECORD

@@ -0,0 +1,45 @@
+pyhive/__init__.py,sha256=kCvWR_847-zXI1Wvz54ZSlUG1XgNsKdxxUnpZmY3JqE,406
+pyhive/client.py,sha256=MYO7AoYxFQnkf2u2-VMwOiTeuVNbeP9CAtuPydUVoqg,10965
+pyhive/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyhive/src/authenticated_hive_client.py,sha256=u6YxLYg1e2p8sDiC72iWlEb221eExv-0ppbZBjpnvm0,8459
+pyhive/src/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyhive/src/types/assignment.py,sha256=wTk6UrUMcmH6yR3cSGk5OJZ4ZCSE5B4xcwuzNYyDAUU,7703
+pyhive/src/types/class_.py,sha256=rZPOYkGSiVQxs8ELt6jIgntL0jfcjKVefLYoM0sC-QI,3666
+pyhive/src/types/common.py,sha256=ZqvRt31LiOen6OJAr3fqdlKjwm87l5STh_gX5vSS2vQ,1459
+pyhive/src/types/core_item.py,sha256=CuLnEIjAHXEs9wCEkHxmU-YjukgTguCdFuy-ugGJvL4,620
+pyhive/src/types/event.py,sha256=YZG6cD82_I6uQTSm3byMlwRlCpaMxkUOFLikFesPyl8,5009
+pyhive/src/types/event_attendees_type_0_item.py,sha256=uSS1vcRHjPdHan2eZpXDZ9yTd3C9kNnNL6xApQQv8og,1584
+pyhive/src/types/event_color.py,sha256=nZMg9PkEKVs1bnoenlS3mKVngPSx0bIGPstrS0p5Dhc,1297
+pyhive/src/types/exercise.py,sha256=glxJwz6XSN7LYmdcUIWLp1IK7EZnkc-6sB7LqAVX-qA,7742
+pyhive/src/types/form_field.py,sha256=TKOod2Zoy15xeKUVDUmHarQYohdjFPSnDx-oXX8ZhiU,5426
+pyhive/src/types/help_.py,sha256=qAm6Wk3LTzbdgQezy5K62HMezXvuN6vHrfqpmNLqfXc,8883
+pyhive/src/types/help_response.py,sha256=GznWHto7YrYPxhLZtXD7D2pCEsNiUiyE2c-s2R6G1Pk,3913
+pyhive/src/types/help_response_segel_nested.py,sha256=blRiDk79KklcapdFSPQJ1C1lZ-U5Ri75B1jBucklO1c,3682
+pyhive/src/types/module.py,sha256=ksZLAgq5fnn5Z_zR1qKHVqPx5ZBb6UvaQn2_dvEoVnI,3736
+pyhive/src/types/notification_nested.py,sha256=Dph6phG3uanZ5MF8J1HvXzM_hLsFH-MHKtvv_gunuzE,2474
+pyhive/src/types/program.py,sha256=ncgUJEzhUa_x-Zf1f8cN3xrXnn-728JiP40gtauVmCA,6809
+pyhive/src/types/queue.py,sha256=UcTV4Edaviz6jgsioNYGU75qaZIsC8JRHdDw2-WNO4c,5440
+pyhive/src/types/queue_item.py,sha256=lqqBgjDm6Y99NdPCVa3A9a8SJcGb81YfDDbc7YiB65E,3029
+pyhive/src/types/subject.py,sha256=SseTYTsl20x1GF-DsD86gii9nU_uLxSXUO7eaof9LJ8,3851
+pyhive/src/types/tag.py,sha256=PrlzcnGFbh6XgnG6A8Eu9in_yRbw48vOHqPathizxAo,1214
+pyhive/src/types/user.py,sha256=MwtxCchYu6SkTBOqTZl_Mwtf31pc9d1q5cRGJ3xWiNs,12420
+pyhive/src/types/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyhive/src/types/enums/action_enum.py,sha256=S4W6h-wlQoF_qqslfGqtH6oBZUa73rEgGOwzYv_8ZRw,407
+pyhive/src/types/enums/assignment_status_enum.py,sha256=ZrJTJoebReGLtAaZbrirJiG5E-a88LIynvUerCXJLro,380
+pyhive/src/types/enums/class_type_enum.py,sha256=IhY48Uny5BDm3Pm3s-YFsyrabej-m_ASlN5NmvagEs0,246
+pyhive/src/types/enums/clearance_enum.py,sha256=HX-yJ8Lsmew45vCbxc5cpqYv2pAI44e0Mvik3oLcUhw,359
+pyhive/src/types/enums/event_type_enum.py,sha256=CpzWelmTzfK9IuSis-oFojkMep4-LjN9tghvfVWUOjY,414
+pyhive/src/types/enums/exercise_patbas_enum.py,sha256=34ZTpd7k06voBDRlqfNlXiZhYJbCHBRelpK-T6ng1LA,296
+pyhive/src/types/enums/exercise_preview_types.py,sha256=j86WKWKpmRzNGXWIo9_s2GOpGNXNHber3T037EGAdlk,355
+pyhive/src/types/enums/form_field_type_enum.py,sha256=v2vb1WrmD3TDD9pCRCHkVv1eFFc-flB706hk_x3OlJk,335
+pyhive/src/types/enums/gender_enum.py,sha256=O0MK7H08VkfRWpM4LRNxr88oij7SLUXjDqcrUFMQsHg,260
+pyhive/src/types/enums/help_response_type_enum.py,sha256=XKO99KflEqch1PZRdWGBTrXpo7s2dLALF2PRb092r4k,308
+pyhive/src/types/enums/help_status_enum.py,sha256=u2EGVw4v9lQyo8cEQoj5tA0jcVlgqXfrOcL-LtoVEwo,215
+pyhive/src/types/enums/help_type_enum.py,sha256=gQe-2T1u1fKEnAtdrEm5Ph58Kp-h3iyoj7rvuAZv0ow,384
+pyhive/src/types/enums/queue_rule_enum.py,sha256=t_WqpevMrHu0JtttbYlI3pbGEi2iK9e4n31D4xwkQJc,364
+pyhive/src/types/enums/status_enum.py,sha256=AZM_5dfrr3LT1kfFwwMaionNM_DgdgpguWhcoCjcgXs,478
+pyhive/src/types/enums/sync_status_enum.py,sha256=5HO_Xd0nS03252SbDfziXQubvaQ9YLvrjczdV2rt-Lk,338
+pyhive/src/types/enums/visibility_enum.py,sha256=dq1vNHg_i247irxWyBzXNST1tPiS46TpH9r1WmfwOZ0,355
+pyhivelms-5.12.0.dist-info/METADATA,sha256=f8_g6K3P_rDDPj759rVJpeHfJ0Ng5hvt531xI91mhgE,3088
+pyhivelms-5.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyhivelms-5.12.0.dist-info/RECORD,,

pyhivelms-5.12.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any