Regenerate documentation

Author: github-actions[bot]

docs/grades.html

@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="edupage_api.grades.EduGrade"><code class="flex name class">
 <span>class <span class="ident">EduGrade</span></span>
-<span>(</span><span>event_id: int,<br>title: str,<br>grade_n: int | float | str | None,<br>comment: str | None,<br>date: datetime.datetime,<br>subject_id: int,<br>subject_name: str | None,<br>teacher: <a title="edupage_api.people.EduTeacher" href="people.html#edupage_api.people.EduTeacher">EduTeacher</a> | None,<br>max_points: float | None,<br>importance: float,<br>verbal: bool,<br>percent: float)</span>
+<span>(</span><span>event_id: int,<br>title: str,<br>grade_n: int | float | str | None,<br>comment: str | None,<br>date: datetime.datetime,<br>subject_id: int,<br>subject_name: str | None,<br>teacher: <a title="edupage_api.people.EduTeacher" href="people.html#edupage_api.people.EduTeacher">EduTeacher</a> | None,<br>max_points: float | None,<br>more_details: list[str] | None,<br>importance: float,<br>verbal: bool,<br>percent: float,<br>class_grade_avg: float | None)</span>
 </code></dt>
 <dd>
 <details class="source">
@@ -66,13 +66,19 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     subject_name: Optional[str]
     teacher: Optional[EduTeacher]
     max_points: Optional[float]
+    more_details: Optional[list[str]]
     importance: float
     verbal: bool
-    percent: float</code></pre>
+    percent: float
+    class_grade_avg: Optional[float]</code></pre>
 </details>
-<div class="desc"><p>EduGrade(event_id: int, title: str, grade_n: Union[int, float, str, NoneType], comment: Optional[str], date: datetime.datetime, subject_id: int, subject_name: Optional[str], teacher: Optional[edupage_api.people.EduTeacher], max_points: Optional[float], importance: float, verbal: bool, percent: float)</p></div>
+<div class="desc"><p>EduGrade(event_id: int, title: str, grade_n: Union[int, float, str, NoneType], comment: Optional[str], date: datetime.datetime, subject_id: int, subject_name: Optional[str], teacher: Optional[edupage_api.people.EduTeacher], max_points: Optional[float], more_details: Optional[list[str]], importance: float, verbal: bool, percent: float, class_grade_avg: Optional[float])</p></div>
 <h3>Instance variables</h3>
 <dl>
+<dt id="edupage_api.grades.EduGrade.class_grade_avg"><code class="name">var <span class="ident">class_grade_avg</span> : float | None</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="edupage_api.grades.EduGrade.comment"><code class="name">var <span class="ident">comment</span> : str | None</code></dt>
 <dd>
 <div class="desc"></div>
@@ -97,6 +103,10 @@ <h3>Instance variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="edupage_api.grades.EduGrade.more_details"><code class="name">var <span class="ident">more_details</span> : list[str] | None</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="edupage_api.grades.EduGrade.percent"><code class="name">var <span class="ident">percent</span> : float</code></dt>
 <dd>
 <div class="desc"></div>
@@ -222,6 +232,14 @@ <h3>Instance variables</h3>
                 max_points = float(details.get(&#34;p_vaha_body&#34;))
                 importance = float(details.get(&#34;p_vaha&#34;)) / 20
 
+            # More details coming from Edupage metadata
+            more_details_raw = details.get(&#34;moredata&#34;)
+            if isinstance(more_details_raw, list):
+                more_details = [str(item) for item in more_details_raw]
+            elif more_details_raw is None:
+                more_details = None
+            else:
+                more_details = [str(more_details_raw)]
             # Grade
             grade_raw = grade.get(&#34;data&#34;).split(&#34; (&#34;, 1)
             if grade_raw[0].isdigit():
@@ -247,6 +265,8 @@ <h3>Instance variables</h3>
             except:
                 verbal = True
 
+            class_grade_avg = None if details.get(&#34;priemer&#34;) is None else float(details.get(&#34;priemer&#34;))
+
             grade = EduGrade(
                 event_id,
                 title,
@@ -257,9 +277,11 @@ <h3>Instance variables</h3>
                 subject_name,
                 teacher,
                 max_points,
+                more_details,
                 importance,
                 verbal,
                 percent,
+                class_grade_avg
             )
             output.append(grade)
 
@@ -344,6 +366,14 @@ <h3>Methods</h3>
             max_points = float(details.get(&#34;p_vaha_body&#34;))
             importance = float(details.get(&#34;p_vaha&#34;)) / 20
 
+        # More details coming from Edupage metadata
+        more_details_raw = details.get(&#34;moredata&#34;)
+        if isinstance(more_details_raw, list):
+            more_details = [str(item) for item in more_details_raw]
+        elif more_details_raw is None:
+            more_details = None
+        else:
+            more_details = [str(more_details_raw)]
         # Grade
         grade_raw = grade.get(&#34;data&#34;).split(&#34; (&#34;, 1)
         if grade_raw[0].isdigit():
@@ -369,6 +399,8 @@ <h3>Methods</h3>
         except:
             verbal = True
 
+        class_grade_avg = None if details.get(&#34;priemer&#34;) is None else float(details.get(&#34;priemer&#34;))
+
         grade = EduGrade(
             event_id,
             title,
@@ -379,9 +411,11 @@ <h3>Methods</h3>
             subject_name,
             teacher,
             max_points,
+            more_details,
             importance,
             verbal,
             percent,
+            class_grade_avg
         )
         output.append(grade)
 
@@ -439,12 +473,14 @@ <h3>Class variables</h3>
 <li>
 <h4><code><a title="edupage_api.grades.EduGrade" href="#edupage_api.grades.EduGrade">EduGrade</a></code></h4>
 <ul class="two-column">
+<li><code><a title="edupage_api.grades.EduGrade.class_grade_avg" href="#edupage_api.grades.EduGrade.class_grade_avg">class_grade_avg</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.comment" href="#edupage_api.grades.EduGrade.comment">comment</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.date" href="#edupage_api.grades.EduGrade.date">date</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.event_id" href="#edupage_api.grades.EduGrade.event_id">event_id</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.grade_n" href="#edupage_api.grades.EduGrade.grade_n">grade_n</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.importance" href="#edupage_api.grades.EduGrade.importance">importance</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.max_points" href="#edupage_api.grades.EduGrade.max_points">max_points</a></code></li>
+<li><code><a title="edupage_api.grades.EduGrade.more_details" href="#edupage_api.grades.EduGrade.more_details">more_details</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.percent" href="#edupage_api.grades.EduGrade.percent">percent</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.subject_id" href="#edupage_api.grades.EduGrade.subject_id">subject_id</a></code></li>
 <li><code><a title="edupage_api.grades.EduGrade.subject_name" href="#edupage_api.grades.EduGrade.subject_name">subject_name</a></code></li>

docs/index.html

@@ -292,6 +292,20 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         return TimelineEvents(self).get_notifications()
 
+    def get_notification_history(self, date_from: date) -&gt; list[TimelineEvent]:
+        &#34;&#34;&#34;Get a list of all available notifications since `date_from` (until now).
+
+        This method can be used instead of `get_notifications` if notifications older than
+        1 month are needed.
+
+        Args:
+            date_from (datetime.date): The first day of the date range
+
+        Returns:
+            list[TimelineEvent]: List of all notifications since `date_from` up to now.
+        &#34;&#34;&#34;
+        return TimelineEvents(self).get_notifications_history(date_from)
+
     def cloud_upload(self, fd: TextIOWrapper) -&gt; EduCloudFile:
         &#34;&#34;&#34;Upload file to EduPage cloud.
 
@@ -823,6 +837,42 @@ <h2 id="returns">Returns</h2>
 <dd>The type (break or lesson) and time of the next ringing.</dd>
 </dl></div>
 </dd>
+<dt id="edupage_api.Edupage.get_notification_history"><code class="name flex">
+<span>def <span class="ident">get_notification_history</span></span>(<span>self, date_from: datetime.date) ‑> list[<a title="edupage_api.timeline.TimelineEvent" href="timeline.html#edupage_api.timeline.TimelineEvent">TimelineEvent</a>]</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def get_notification_history(self, date_from: date) -&gt; list[TimelineEvent]:
+    &#34;&#34;&#34;Get a list of all available notifications since `date_from` (until now).
+
+    This method can be used instead of `get_notifications` if notifications older than
+    1 month are needed.
+
+    Args:
+        date_from (datetime.date): The first day of the date range
+
+    Returns:
+        list[TimelineEvent]: List of all notifications since `date_from` up to now.
+    &#34;&#34;&#34;
+    return TimelineEvents(self).get_notifications_history(date_from)</code></pre>
+</details>
+<div class="desc"><p>Get a list of all available notifications since <code>date_from</code> (until now).</p>
+<p>This method can be used instead of <code>get_notifications</code> if notifications older than
+1 month are needed.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>date_from</code></strong> :&ensp;<code>datetime.date</code></dt>
+<dd>The first day of the date range</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>list[TimelineEvent]</code></dt>
+<dd>List of all notifications since <code>date_from</code> up to now.</dd>
+</dl></div>
+</dd>
 <dt id="edupage_api.Edupage.get_notifications"><code class="name flex">
 <span>def <span class="ident">get_notifications</span></span>(<span>self) ‑> list[<a title="edupage_api.timeline.TimelineEvent" href="timeline.html#edupage_api.timeline.TimelineEvent">TimelineEvent</a>]</span>
 </code></dt>
@@ -1244,6 +1294,7 @@ <h4><code><a title="edupage_api.Edupage" href="#edupage_api.Edupage">Edupage</a>
 <li><code><a title="edupage_api.Edupage.get_missing_teachers" href="#edupage_api.Edupage.get_missing_teachers">get_missing_teachers</a></code></li>
 <li><code><a title="edupage_api.Edupage.get_my_timetable" href="#edupage_api.Edupage.get_my_timetable">get_my_timetable</a></code></li>
 <li><code><a title="edupage_api.Edupage.get_next_ringing_time" href="#edupage_api.Edupage.get_next_ringing_time">get_next_ringing_time</a></code></li>
+<li><code><a title="edupage_api.Edupage.get_notification_history" href="#edupage_api.Edupage.get_notification_history">get_notification_history</a></code></li>
 <li><code><a title="edupage_api.Edupage.get_notifications" href="#edupage_api.Edupage.get_notifications">get_notifications</a></code></li>
 <li><code><a title="edupage_api.Edupage.get_school_year" href="#edupage_api.Edupage.get_school_year">get_school_year</a></code></li>
 <li><code><a title="edupage_api.Edupage.get_students" href="#edupage_api.Edupage.get_students">get_students</a></code></li>