schoolmospy 0.0.2__tar.gz → 0.2.1__tar.gz

schoolmospy-0.2.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: schoolmospy
+Version: 0.2.1
+Summary: A lightweight async Python wrapper for school.mos.ru APIs
+License: GPL-3.0-only
+License-File: LICENSE
+Keywords: school,mos,api,education,async,wrapper,python
+Author: Ivan Kriventsev
+Author-email: xd2dd@icloud.com
+Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.12.15,<4.0.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: pydantic (>=2.11.9,<3.0.0)
+Project-URL: Documentation, https://xd2dd.github.io/schoolmospy
+Project-URL: Homepage, https://github.com/xd2dd/schoolmospy
+Project-URL: Issues, https://github.com/xd2dd/schoolmospy/issues
+Description-Content-Type: text/markdown
+
+![Badge](https://img.shields.io/badge/version-0.2.0-blue.svg)
+![Python](https://img.shields.io/badge/python-3.12+-blue.svg)
+![License](https://img.shields.io/badge/license-GPL--3.0-green.svg)
+
+# 📕 SchoolMosPy
+
+SchoolMosPy is a lightweight async Python wrapper for school.mos.ru APIs. It provides a simple and intuitive interface to interact with the Moscow School Electronic Diary platform.
+
+## ✨ Features
+
+- **Async architecture** - built on `aiohttp` and `httpx` for high performance
+- **Type safety** - uses `pydantic` for data validation
+- **Simple API** - intuitive interface for working with data
+- **Full-featured** - access to marks, homeworks, events, and profile data
+
+## 📋 Requirements
+
+- Python 3.12+
+- aiohttp >= 3.12.15
+- pydantic >= 2.11.9
+- httpx >= 0.28.1
+
+## 📦 Installation
+
+```bash
+pip install schoolmospy
+```
+
+## 🚀 Quick Start
+
+```python
+import asyncio
+from schoolmospy import StudentClient
+
+async def main():
+    # Create client
+    client = StudentClient(
+        token="your_token",
+        profile_id=12345
+    )
+
+    # Get profile
+    profile = await client.get_me()
+    print(f"Name: {profile.name}")
+
+    # Get marks
+    marks = await client.marks.get_marks(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    # Get homeworks
+    homeworks = await client.homeworks.get_homeworks(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    # Get events/schedule
+    events = await client.events.get_events(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    await client.close()
+
+asyncio.run(main())
+```
+
+## 📝 License
+
+This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.
+
+## 🔗 Links
+
+- [Documentation](https://xd2dd.github.io/schoolmospy)
+- [Report an Issue](https://github.com/xd2dd/schoolmospy/issues)
+
+## 👨‍💻 Author
+
+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/README.md

@@ -0,0 +1,84 @@
+![Badge](https://img.shields.io/badge/version-0.2.0-blue.svg)
+![Python](https://img.shields.io/badge/python-3.12+-blue.svg)
+![License](https://img.shields.io/badge/license-GPL--3.0-green.svg)
+
+# 📕 SchoolMosPy
+
+SchoolMosPy is a lightweight async Python wrapper for school.mos.ru APIs. It provides a simple and intuitive interface to interact with the Moscow School Electronic Diary platform.
+
+## ✨ Features
+
+- **Async architecture** - built on `aiohttp` and `httpx` for high performance
+- **Type safety** - uses `pydantic` for data validation
+- **Simple API** - intuitive interface for working with data
+- **Full-featured** - access to marks, homeworks, events, and profile data
+
+## 📋 Requirements
+
+- Python 3.12+
+- aiohttp >= 3.12.15
+- pydantic >= 2.11.9
+- httpx >= 0.28.1
+
+## 📦 Installation
+
+```bash
+pip install schoolmospy
+```
+
+## 🚀 Quick Start
+
+```python
+import asyncio
+from schoolmospy import StudentClient
+
+async def main():
+    # Create client
+    client = StudentClient(
+        token="your_token",
+        profile_id=12345
+    )
+
+    # Get profile
+    profile = await client.get_me()
+    print(f"Name: {profile.name}")
+
+    # Get marks
+    marks = await client.marks.get_marks(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    # Get homeworks
+    homeworks = await client.homeworks.get_homeworks(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    # Get events/schedule
+    events = await client.events.get_events(
+        from_date="2024-01-01",
+        to_date="2024-12-31"
+    )
+
+    await client.close()
+
+asyncio.run(main())
+```
+
+## 📝 License
+
+This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.
+
+## 🔗 Links
+
+- [Documentation](https://xd2dd.github.io/schoolmospy)
+- [Report an Issue](https://github.com/xd2dd/schoolmospy/issues)
+
+## 👨‍💻 Author
+
+Ivan Kriventsev - [xd2dd@icloud.com](mailto:xd2dd@icloud.com)
+
+---
+
+⭐ If you like this project, please give it a star on GitHub!

{schoolmospy-0.0.2 → schoolmospy-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "schoolmospy"
-version = "0.0.2"
+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"
@@ -20,6 +20,7 @@ classifiers = [
 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" }]

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

@@ -33,16 +33,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
         return headers
 
     async def _handle_response(self, response: httpx.Response, response_model: Optional[Type[BaseModel]] = None):
-        """Обработка ответа и ошибок"""
         if response.is_success:
             if response_model:
                 return response_model.model_validate(response.json())
             return response.json()
 
-        # Ошибки
         text = response.text.strip()
         status = response.status_code
 

schoolmospy-0.2.1/schoolmospy/core/events_client.py

@@ -0,0 +1,62 @@
+from datetime import datetime
+from schoolmospy.core.basic_client import BasicClient
+from schoolmospy.models.events import Events
+
+
+class EventClient:
+    def __init__(self, client: BasicClient):
+        """
+        Initialization the EventClient instance.
+
+        Args:
+            client (BasicClient): An instance of BasicClient or any compatible subclass,
+                used for making API requests.
+        """
+        self.client = client
+
+    async def get(self, from_date: datetime, to_date: datetime, contingent_guid: str = None) -> Events:
+        """
+        Method for getting events done within a certain period of time
+
+        Args:
+            from_date (datetime): The start date of the period (inclusive).
+            to_date (datetime): The end date of the period (inclusive).
+            contingent_guid (str): Person ID
+
+        Returns:
+            Events: A Pydantic model containing a list of events items.
+
+        Raises:
+            APIError: If the request fails or returns an unexpected response.
+            AuthError: If the provided token is invalid or expired.
+
+        Example:
+            ```python
+            from datetime import datetime
+            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(
+                from_date=datetime(2025, 10, 1),
+                to_date=datetime(2025, 10, 24),
+                contingent_guid=me.contingent_guid
+            )
+            print(events.response)
+            ```
+        """
+
+
+        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"),
+                "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"  
+            }
+        )

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

@@ -4,6 +4,7 @@ from schoolmospy.models.profile import Profile
 from schoolmospy.models.userinfo import Userinfo
 from schoolmospy.core.homeworks_client import HomeworkClient
 from schoolmospy.core.marks_client import MarksClient
+from schoolmospy.core.events_client import EventClient
 
 
 class StudentClient(BasicClient):
@@ -16,15 +17,28 @@ class StudentClient(BasicClient):
         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.
+
+        Returns:
+            Profile: Profile object containing user data
+        """
         return await self.get(
             "/api/family/web/v1/profile",
             Profile,
         )
-    
+
     async def userinfo(self) -> Userinfo:
+        """
+        Get basic user information from OAuth.
+
+        Returns:
+            Userinfo: Object with basic user information
+        """
         return await self.get(
             "/v1/oauth/userinfo",
             Userinfo

schoolmospy-0.2.1/schoolmospy/models/events.py

@@ -0,0 +1,37 @@
+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.0.2 → schoolmospy-0.2.1}/schoolmospy/models/homeworks.py

@@ -24,7 +24,7 @@ class Material(BaseModel):
     action_name: str
 
 
-class PayloadItem(BaseModel):
+class HomeworkItem(BaseModel):
     type: str
     description: str
     comments: List
@@ -49,4 +49,4 @@ class PayloadItem(BaseModel):
 
 
 class Homeworks(BaseModel):
-    payload: List[PayloadItem]
+    payload: List[HomeworkItem]

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

@@ -20,7 +20,7 @@ class Value(BaseModel):
     grade_system_type: str
 
 
-class PayloadItem(BaseModel):
+class MarkItem(BaseModel):
     id: int
     value: str
     values: List[Value]
@@ -42,4 +42,4 @@ class PayloadItem(BaseModel):
 
 
 class Marks(BaseModel):
-    payload: List[PayloadItem]
+    payload: List[MarkItem]

schoolmospy-0.0.2/PKG-INFO

@@ -1,28 +0,0 @@
-Metadata-Version: 2.4
-Name: schoolmospy
-Version: 0.0.2
-Summary: A lightweight async Python wrapper for school.mos.ru APIs
-License: GPL-3.0-only
-License-File: LICENSE
-Keywords: school,mos,api,education,async,wrapper,python
-Author: Ivan Kriventsev
-Author-email: xd2dd@icloud.com
-Requires-Python: >=3.12
-Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: aiohttp (>=3.12.15,<4.0.0)
-Requires-Dist: pydantic (>=2.11.9,<3.0.0)
-Project-URL: Documentation, https://xd2dd.github.io/schoolmospy
-Project-URL: Homepage, https://github.com/xd2dd/schoolmospy
-Project-URL: Issues, https://github.com/xd2dd/schoolmospy/issues
-Description-Content-Type: text/markdown
-
-# 📕 SchoolMosPy
-
-SchoolMosPy - a lightweight Python wrapper for school.mos.py APIs.
-
-
-

schoolmospy-0.0.2/README.md

@@ -1,5 +0,0 @@
-# 📕 SchoolMosPy
-
-SchoolMosPy - a lightweight Python wrapper for school.mos.py APIs.
-
-