schoolmospy 0.2.1__tar.gz → 0.2.3__tar.gz

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: schoolmospy
-Version: 0.2.1
+Version: 0.2.3
 Summary: A lightweight async Python wrapper for school.mos.ru APIs
 License: GPL-3.0-only
 License-File: LICENSE
@@ -67,19 +67,19 @@ async def main():
     print(f"Name: {profile.name}")
 
     # Get marks
-    marks = await client.marks.get_marks(
+    marks = await client.marks.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
 
     # Get homeworks
-    homeworks = await client.homeworks.get_homeworks(
+    homeworks = await client.homeworks.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
 
     # Get events/schedule
-    events = await client.events.get_events(
+    events = await client.events.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
@@ -103,6 +103,3 @@ This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) f
 Ivan Kriventsev - [xd2dd@icloud.com](mailto:xd2dd@icloud.com)
 
 ---
-
-⭐ If you like this project, please give it a star on GitHub!
-

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/README.md

@@ -44,19 +44,19 @@ async def main():
     print(f"Name: {profile.name}")
 
     # Get marks
-    marks = await client.marks.get_marks(
+    marks = await client.marks.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
 
     # Get homeworks
-    homeworks = await client.homeworks.get_homeworks(
+    homeworks = await client.homeworks.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
 
     # Get events/schedule
-    events = await client.events.get_events(
+    events = await client.events.get(
         from_date="2024-01-01",
         to_date="2024-12-31"
     )
@@ -79,6 +79,4 @@ This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) f
 
 Ivan Kriventsev - [xd2dd@icloud.com](mailto:xd2dd@icloud.com)
 
----
-
-⭐ If you like this project, please give it a star on GitHub!
+---

schoolmospy-0.2.3/pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "schoolmospy"
+version = "0.2.3"
+description = "A lightweight async Python wrapper for school.mos.ru APIs"
+authors = [{ name = "Ivan Kriventsev", email = "xd2dd@icloud.com" }]
+readme = "README.md"
+license = { text = "GPL-3.0-only" }
+requires-python = ">=3.12"
+
+keywords = ["school", "mos", "api", "education", "async", "wrapper", "python"]
+
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+dependencies = [
+    "aiohttp >=3.12.15,<4.0.0",
+    "pydantic >=2.11.9,<3.0.0",
+    "httpx (>=0.28.1,<0.29.0)",
+]
+
+packages = [{ include = "schoolmospy" }]
+
+[project.urls]
+"Homepage" = "https://github.com/xd2dd/schoolmospy"
+"Documentation" = "https://xd2dd.github.io/schoolmospy"
+"Issues" = "https://github.com/xd2dd/schoolmospy/issues"
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.13.2"
+mypy = "^1.18.2"
+black = "^25.9.0"
+isort = "^6.0.1"
+pre-commit = "^4.0.0"
+
+[tool.black]
+line-length = 100
+target-version = ["py312"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "F",    # pyflakes
+    "W",    # pycodestyle warnings
+    "I",    # isort
+    "N",    # pep8-naming
+    "UP",   # pyupgrade
+    "ANN",  # flake8-annotations
+    "B",    # flake8-bugbear
+    "A",    # flake8-builtins
+    "C4",   # flake8-comprehensions
+    "RET",  # flake8-return
+    "SIM",  # flake8-simplify
+    "ARG",  # flake8-unused-arguments
+    "PTH",  # flake8-use-pathlib
+    "RUF",  # Ruff-specific rules
+]
+ignore = [
+    "ANN101",   # Missing type annotation for self in method
+    "ANN102",   # Missing type annotation for cls in classmethod
+    "ANN401",   # Dynamically typed expressions (typing.Any) are disallowed
+    "TRY003",   # Avoid specifying long messages outside the exception class
+    "EM101",    # Exception must not use a string literal
+    "PLR2004",  # Magic value used in comparison
+    "COM812",   # Trailing comma missing (conflicts with formatter)
+]
+
+[tool.mypy]
+python_version = "3.12"
+ignore_missing_imports = true
+warn_return_any = false
+warn_unused_ignores = true
+disallow_untyped_defs = false
+check_untyped_defs = true

schoolmospy-0.2.3/schoolmospy/__init__.py

@@ -0,0 +1,4 @@
+from schoolmospy.core.basic_client import BasicClient as BasicClient
+from schoolmospy.core.student_client import StudentClient as StudentClient
+
+__all__ = ["BasicClient", "StudentClient"]

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/core/basic_client.py

@@ -1,23 +1,26 @@
+from typing import Any
+
 import httpx
-from typing import Any, Optional, Type
 from pydantic import BaseModel
-from schoolmospy.utils.exceptions import APIError, AuthError, NotFoundError, ServerError, HTTPError
+
+from schoolmospy.utils.exceptions import APIError, AuthError, HTTPError, NotFoundError, ServerError
 
 
 class BasicClient:
     def __init__(
         self,
         base_url: str,
-        token: Optional[str] = None,
-        profile_id: Optional[int] = None,
+        token: str | None = None,
+        profile_id: int | None = None,
         profile_type: str = "student",
         timeout: float = 15.0,
-    ):
+    ) -> None:
         self.base_url = base_url.rstrip("/")
         self.token = token
         self.profile_id = profile_id
         self.profile_type = profile_type
         self.timeout = timeout
+        self.extra_headers: dict[str, str] = {}
 
     @property
     def headers(self) -> dict[str, str]:
@@ -33,10 +36,15 @@ class BasicClient:
             headers["Profile-Id"] = str(self.profile_id)
         if self.profile_type:
             headers["Profile-Type"] = self.profile_type
-            headers["X-Mes-Role"]   = self.profile_type
+        if self.extra_headers:
+            headers.update(self.extra_headers)
         return headers
 
-    async def _handle_response(self, response: httpx.Response, response_model: Optional[Type[BaseModel]] = None):
+    async def _handle_response(
+        self,
+        response: httpx.Response,
+        response_model: type[BaseModel] | None = None,
+    ) -> Any:
         if response.is_success:
             if response_model:
                 return response_model.model_validate(response.json())
@@ -47,25 +55,41 @@ class BasicClient:
 
         if status == 401:
             raise AuthError("Unauthorized or invalid token", status, text)
-        elif status == 404:
+        if status == 404:
             raise NotFoundError("Resource not found", status, text)
-        elif status >= 500:
+        if status >= 500:
             raise ServerError("Server error", status, text)
-        else:
-            raise HTTPError(f"Unexpected response ({status})", status, text)
+        raise HTTPError(f"Unexpected response ({status})", status, text)
 
-    async def get(self, endpoint: str, response_model: Optional[Type[BaseModel]] = None, **kwargs: Any):
+    async def get(
+        self,
+        endpoint: str,
+        response_model: type[BaseModel] | None = None,
+        **kwargs: Any,
+    ) -> Any:
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
-        async with httpx.AsyncClient(headers=self.headers, timeout=self.timeout) as client:
+        headers = self.headers
+        if "headers" in kwargs:
+            headers = {**headers, **kwargs.pop("headers")}
+        async with httpx.AsyncClient(headers=headers, timeout=self.timeout) as client:
             try:
                 resp = await client.get(url, **kwargs)
             except httpx.RequestError as e:
                 raise APIError(f"Request failed: {e}") from e
             return await self._handle_response(resp, response_model)
 
-    async def post(self, endpoint: str, data: Any = None, response_model: Optional[Type[BaseModel]] = None, **kwargs: Any):
+    async def post(
+        self,
+        endpoint: str,
+        data: Any = None,
+        response_model: type[BaseModel] | None = None,
+        **kwargs: Any,
+    ) -> Any:
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
-        async with httpx.AsyncClient(headers=self.headers, timeout=self.timeout) as client:
+        headers = self.headers
+        if "headers" in kwargs:
+            headers = {**headers, **kwargs.pop("headers")}
+        async with httpx.AsyncClient(headers=headers, timeout=self.timeout) as client:
             try:
                 resp = await client.post(url, json=data, **kwargs)
             except httpx.RequestError as e:

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/core/events_client.py

@@ -1,10 +1,11 @@
 from datetime import datetime
+
 from schoolmospy.core.basic_client import BasicClient
 from schoolmospy.models.events import Events
 
 
 class EventClient:
-    def __init__(self, client: BasicClient):
+    def __init__(self, client: BasicClient) -> None:
         """
         Initialization the EventClient instance.
 
@@ -14,7 +15,7 @@ class EventClient:
         """
         self.client = client
 
-    async def get(self, from_date: datetime, to_date: datetime, contingent_guid: str = None) -> Events:
+    async def get(self, from_date: datetime, to_date: datetime, contingent_guid: str) -> Events:
         """
         Method for getting events done within a certain period of time
 
@@ -36,7 +37,7 @@ class EventClient:
             from schoolmospy.clients.student_client import StudentClient
 
             client = StudentClient(token="YOUR_TOKEN", profile_id=17234613)
-            
+
             me = await client.get_me()
 
             events = await client.events.get(
@@ -48,15 +49,15 @@ class EventClient:
             ```
         """
 
-
         return await self.client.get(
             "/api/eventcalendar/v1/api/events",
             Events,
             params={
-                "from": from_date.strftime("%Y-%m-%d"),
-                "to": to_date.strftime("%Y-%m-%d"),
+                "begin_date": from_date.strftime("%Y-%m-%d"),
+                "end_date": to_date.strftime("%Y-%m-%d"),
                 "person_ids": contingent_guid,
                 "expand": "marks,homework,absence_reason_id,health_status,nonattendance_reason_id",
-                "source_types": "PLAN,AE,EC,EVENTS,AFISHA,ORGANIZER,OLYMPIAD,PROF"  
-            }
+                "source_types": "PLAN,AE,EC,EVENTS,AFISHA,ORGANIZER,OLYMPIAD,PROF",
+            },
+            headers={"X-Mes-Role": "student"},
         )

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/core/homeworks_client.py

@@ -1,10 +1,11 @@
 from datetime import datetime
+
 from schoolmospy.core.basic_client import BasicClient
 from schoolmospy.models.homeworks import Homeworks
 
 
 class HomeworkClient:
-    def __init__(self, client: BasicClient):
+    def __init__(self, client: BasicClient) -> None:
         """
         Initialization the HomeworkClient instance.
 
@@ -43,13 +44,12 @@ class HomeworkClient:
             ```
         """
 
-
         return await self.client.get(
             "/api/family/web/v1/homeworks",
             Homeworks,
             params={
                 "from": from_date.strftime("%Y-%m-%d"),
                 "to": to_date.strftime("%Y-%m-%d"),
-                "student_id": self.client.profile_id
-            }
+                "student_id": self.client.profile_id,
+            },
         )

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/core/marks_client.py

@@ -1,10 +1,11 @@
 from datetime import datetime
+
 from schoolmospy.core.basic_client import BasicClient
 from schoolmospy.models.marks import Marks
 
 
 class MarksClient:
-    def __init__(self, client: BasicClient):
+    def __init__(self, client: BasicClient) -> None:
         self.client = client
 
     async def get(self, from_date: datetime, to_date: datetime) -> Marks:
@@ -41,6 +42,6 @@ class MarksClient:
             params={
                 "from": from_date.strftime("%Y-%m-%d"),
                 "to": to_date.strftime("%Y-%m-%d"),
-                "student_id": self.client.profile_id
-            }
+                "student_id": self.client.profile_id,
+            },
         )

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/core/student_client.py

@@ -1,25 +1,25 @@
-from typing import Optional
 from schoolmospy.core.basic_client import BasicClient
-from schoolmospy.models.profile import Profile
-from schoolmospy.models.userinfo import Userinfo
+from schoolmospy.core.events_client import EventClient
 from schoolmospy.core.homeworks_client import HomeworkClient
 from schoolmospy.core.marks_client import MarksClient
-from schoolmospy.core.events_client import EventClient
+from schoolmospy.models.profile import Profile
+from schoolmospy.models.userinfo import Userinfo
 
 
 class StudentClient(BasicClient):
-    def __init__(self,
-                base_url: str = "https://school.mos.ru",
-                token: Optional[str] = None,
-                profile_id: Optional[int] = None,
-                profile_type: str = "student",
-                timeout: float = 15.0):
+    def __init__(
+        self,
+        base_url: str = "https://school.mos.ru",
+        token: str | None = None,
+        profile_id: int | None = None,
+        profile_type: str = "student",
+        timeout: float = 15.0,
+    ) -> None:
         super().__init__(base_url, token, profile_id, profile_type, timeout)
         self.homeworks = HomeworkClient(self)
         self.marks = MarksClient(self)
         self.events = EventClient(self)
 
-
     async def get_me(self) -> Profile:
         """
         Get the current user's profile information.
@@ -39,7 +39,4 @@ class StudentClient(BasicClient):
         Returns:
             Userinfo: Object with basic user information
         """
-        return await self.get(
-            "/v1/oauth/userinfo",
-            Userinfo
-        )
+        return await self.get("/v1/oauth/userinfo", Userinfo)

schoolmospy-0.2.3/schoolmospy/models/events.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class EventItem(BaseModel):
+    id: int
+    source_id: str
+    source: str
+    start_at: str
+    finish_at: str
+    cancelled: bool | None = None
+    lesson_type: str | None = None
+    course_lesson_type: Any | None = None
+    lesson_form: Any | None = None
+    replaced: bool | None = None
+    room_name: str | None
+    room_number: str | None
+    subject_id: int | None = None
+    subject_name: str
+    link_to_join: Any | None = None
+    health_status: Any
+    absence_reason_id: Any
+    nonattendance_reason_id: Any
+    homework: Any | None = None
+    marks: Any | None = None
+    is_missed_lesson: bool
+    esz_field_id: int | None = None
+    lesson_theme: Any | None = None
+
+
+class Events(BaseModel):
+    total_count: int
+    response: list[EventItem]
+    errors: Any

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/models/homeworks.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, List, Optional
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -11,12 +11,12 @@ class Url(BaseModel):
 
 
 class Material(BaseModel):
-    uuid: Optional[str]
+    uuid: str | None
     type: str
-    selected_mode: Optional[str]
+    selected_mode: str | None
     type_name: str
-    id: Optional[int]
-    urls: List[Url]
+    id: int | None
+    urls: list[Url]
     description: Any
     content_type: Any
     title: str
@@ -27,11 +27,11 @@ class Material(BaseModel):
 class HomeworkItem(BaseModel):
     type: str
     description: str
-    comments: List
-    materials: List[Material]
+    comments: list
+    materials: list[Material]
     homework: str
     homework_entry_student_id: int
-    attachments: List
+    attachments: list
     subject_id: int
     group_id: int
     date: str
@@ -49,4 +49,4 @@ class HomeworkItem(BaseModel):
 
 
 class Homeworks(BaseModel):
-    payload: List[HomeworkItem]
+    payload: list[HomeworkItem]

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/models/marks.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, List
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -23,7 +23,7 @@ class Value(BaseModel):
 class MarkItem(BaseModel):
     id: int
     value: str
-    values: List[Value]
+    values: list[Value]
     comment: str
     weight: int
     point_date: Any
@@ -42,4 +42,4 @@ class MarkItem(BaseModel):
 
 
 class Marks(BaseModel):
-    payload: List[MarkItem]
+    payload: list[MarkItem]

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/models/profile.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, List, Optional
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -44,7 +44,7 @@ class Representative(BaseModel):
     middle_name: str
     type_id: int
     type: str
-    email: Optional[str]
+    email: str | None
     phone: str
     snils: str
 
@@ -74,9 +74,9 @@ class Child(BaseModel):
     class_unit_id: int
     class_uid: str
     age: int
-    groups: List[Group]
-    representatives: List[Representative]
-    sections: List[Section]
+    groups: list[Group]
+    representatives: list[Representative]
+    sections: list[Section]
     sudir_account_exists: bool
     sudir_login: Any
     is_legal_representative: bool
@@ -90,5 +90,5 @@ class Child(BaseModel):
 
 class Profile(BaseModel):
     profile: _Profile
-    children: List[Child]
-    hash: str
+    children: list[Child]
+    hash: str

{schoolmospy-0.2.1 → schoolmospy-0.2.3}/schoolmospy/models/userinfo.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import List
-
 from pydantic import BaseModel, Field
 
 
@@ -23,7 +21,7 @@ class Class(BaseModel):
     parallel: Parallel
     organization: Organization
     education_stage_id: int
-    staff_ids: List[int]
+    staff_ids: list[int]
 
 
 class ServiceType(BaseModel):
@@ -34,7 +32,7 @@ class ServiceType(BaseModel):
 class EducationItem(BaseModel):
     training_begin_at: str
     training_end_at: str
-    class_: Class = Field(..., alias='class')
+    class_: Class = Field(..., alias="class")
     service_type: ServiceType
 
 
@@ -48,9 +46,9 @@ class Userinfo(BaseModel):
     phone: str
     name: str
     gender: str
-    education: List[EducationItem]
-    children: List
-    agents: List[str]
+    education: list[EducationItem]
+    children: list
+    agents: list[str]
     mesh_id: str
     given_name: str
     family_name: str

schoolmospy-0.2.3/schoolmospy/utils/exceptions.py

@@ -0,0 +1,28 @@
+from typing import Any
+
+
+class APIError(Exception):
+    def __init__(
+        self,
+        message: str,
+        status_code: int | None = None,
+        response: Any | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.response = response
+
+    def __str__(self) -> str:
+        return f"{self.__class__.__name__}: {self.args[0]} ({self.status_code}) {self.response}"
+
+
+class AuthError(APIError): ...
+
+
+class NotFoundError(APIError): ...
+
+
+class ServerError(APIError): ...
+
+
+class HTTPError(APIError): ...

schoolmospy-0.2.1/pyproject.toml

@@ -1,42 +0,0 @@
-[project]
-name = "schoolmospy"
-version = "0.2.1"
-description = "A lightweight async Python wrapper for school.mos.ru APIs"
-authors = [{ name = "Ivan Kriventsev", email = "xd2dd@icloud.com" }]
-readme = "README.md"
-license = { text = "GPL-3.0-only" }
-requires-python = ">=3.12"
-
-keywords = ["school", "mos", "api", "education", "async", "wrapper", "python"]
-
-classifiers = [
-    "Programming Language :: Python :: 3.12",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-    "Operating System :: OS Independent",
-    "Intended Audience :: Developers",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-]
-
-dependencies = [
-    "aiohttp >=3.12.15,<4.0.0",
-    "pydantic >=2.11.9,<3.0.0",
-    "httpx (>=0.28.1,<0.29.0)",
-]
-
-packages = [{ include = "schoolmospy" }]
-
-[project.urls]
-"Homepage" = "https://github.com/xd2dd/schoolmospy"
-"Documentation" = "https://xd2dd.github.io/schoolmospy"
-"Issues" = "https://github.com/xd2dd/schoolmospy/issues"
-
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry.group.dev.dependencies]
-ruff = "^0.13.2"
-mypy = "^1.18.2"
-black = "^25.9.0"
-isort = "^6.0.1"

schoolmospy-0.2.1/schoolmospy/__init__.py

@@ -1,2 +0,0 @@
-from schoolmospy.core.student_client import StudentClient
-from schoolmospy.core.basic_client import BasicClient

schoolmospy-0.2.1/schoolmospy/models/events.py

@@ -1,37 +0,0 @@
-from __future__ import annotations
-
-from typing import Any, List, Optional
-
-from pydantic import BaseModel
-
-
-class EventItem(BaseModel):
-    id: int
-    source_id: str
-    source: str
-    start_at: str
-    finish_at: str
-    cancelled: Optional[bool] = None
-    lesson_type: Optional[str] = None
-    course_lesson_type: Optional[Any] = None
-    lesson_form: Optional[Any] = None
-    replaced: Optional[bool] = None
-    room_name: Optional[str]
-    room_number: Optional[str]
-    subject_id: Optional[int] = None
-    subject_name: str
-    link_to_join: Optional[Any] = None
-    health_status: Any
-    absence_reason_id: Any
-    nonattendance_reason_id: Any
-    homework: Optional[Any] = None
-    marks: Optional[Any] = None
-    is_missed_lesson: bool
-    esz_field_id: Optional[int] = None
-    lesson_theme: Optional[Any] = None
-
-
-class Events(BaseModel):
-    total_count: int
-    response: List[EventItem]
-    errors: Any

schoolmospy-0.2.1/schoolmospy/utils/exceptions.py

@@ -1,26 +0,0 @@
-from typing import Optional, Any
-
-
-class APIError(Exception):
-    def __init__(self, message: str, status_code: Optional[int] = None, response: Optional[Any] = None):
-        super().__init__(message)
-        self.status_code = status_code
-        self.response = response
-
-    def __str__(self):
-        return f"{self.__class__.__name__}: {self.args[0]} (status={self.status_code})"
-
-
-class AuthError(APIError):
-    ...
-
-class NotFoundError(APIError):
-    ...
-
-
-class ServerError(APIError):
-    ...
-
-
-class HTTPError(APIError):
-    ...