Package `edupage_api`

Expand source code

import functools
from datetime import date, datetime
from io import TextIOWrapper
from typing import Optional, Union

import requests
from requests import Response

from edupage_api.cloud import Cloud, EduCloudFile
from edupage_api.custom_request import CustomRequest
from edupage_api.foreign_timetables import ForeignTimetables, LessonSkeleton
from edupage_api.grades import EduGrade, Grades, Term
from edupage_api.login import Login, TwoFactorLogin
from edupage_api.lunches import Lunch, Lunches
from edupage_api.messages import Messages
from edupage_api.module import EdupageModule
from edupage_api.parent import Parent
from edupage_api.people import (EduAccount, EduStudent, EduStudentSkeleton,
                                EduTeacher, People)
from edupage_api.ringing import RingingTime, RingingTimes
from edupage_api.substitution import Substitution, TimetableChange
from edupage_api.timeline import TimelineEvent, TimelineEvents
from edupage_api.timetables import Timetable, Timetables


class Edupage(EdupageModule):
    def __init__(self, request_timeout=5):
        """Initialize `Edupage` object.

        Args:
            request_timeout (int, optional): Length of request timeout in seconds.
                If want to upload bigger files, you will have to increase its value.
                Defaults to `5`.
        """

        self.data = None
        self.is_logged_in = False
        self.subdomain = None
        self.gsec_hash = None
        self.username = None

        self.session = requests.session()
        self.session.request = functools.partial(
            self.session.request, timeout=request_timeout
        )

    def login(
        self, username: str, password: str, subdomain: str
    ) -> Optional[TwoFactorLogin]:
        """Login while specifying the subdomain to log into.

        Args:
            username (str): Your username.
            password (str): Your password.
            subdomain (str): Subdomain of your school (https://{subdomain}.edupage.org).

        Returns:
            Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
            or the `TwoFactorLogin` object that is used to complete 2fa.
        """

        return Login(self).login(username, password, subdomain)

    def login_auto(self, username: str, password: str) -> Optional[TwoFactorLogin]:
        """Login using https://portal.edupage.org. If this doesn't work, please use `Edupage.login`.

        Args:
            username (str): Your username.
            password (str): Your password.

        Returns:
            Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
            or the `TwoFactorLogin` object that is used to complete 2fa.
        """

        return Login(self).login(username, password)

    def get_students(self) -> Optional[list[EduStudent]]:
        """Get list of all students in your class.

        Returns:
            Optional[list[EduStudent]]: List of `EduStudent`s.
        """

        return People(self).get_students()

    def get_all_students(self) -> Optional[list[EduStudentSkeleton]]:
        """Get list of all students in your school.

        Returns:
            Optional[list[EduStudentSkeleton]]: List of `EduStudentSkeleton`s.
        """

        return People(self).get_all_students()

    def get_teachers(self) -> Optional[list[EduTeacher]]:
        """Get list of all teachers in your school.

        Returns:
            Optional[list[EduTeacher]]: List of `EduTeacher`s.
        """

        return People(self).get_teachers()

    def send_message(
        self, recipients: Union[list[EduAccount], EduAccount], body: str
    ) -> int:
        """Send message.

        Args:
            recipients (Optional[list[EduAccount]]): Recipients of your message (list of `EduAccount`s).
            body (str): Body of your message.

        Returns:
            int: The timeline id of the new message.
        """

        return Messages(self).send_message(recipients, body)

    def get_timetable(self, date: datetime) -> Optional[Timetable]:
        """Get timetable.

        Args:
            date (datetime): Date from which you want to get timetable.

        Returns:
            Optional[Timetable]: Timetable object for entered date.
        """

        return Timetables(self).get_timetable(date)

    def get_lunches(self, date: datetime) -> Optional[Lunch]:
        """Get lunches.

        Args:
            date (datetime): Date from which you want to get lunches.

        Returns:
            Optional[Lunch]: Lunch object for entered date.
        """

        return Lunches(self).get_lunch(date)

    def get_notifications(self) -> list[TimelineEvent]:
        """Get list of all available notifications.

        Returns:
            list[TimelineEvent]: List of `TimelineEvent`s.
        """

        return TimelineEvents(self).get_notifications()

    def cloud_upload(self, fd: TextIOWrapper) -> EduCloudFile:
        """Upload file to EduPage cloud.

        Args:
            fd (TextIOWrapper): File you want to upload.

        Returns:
            EduCloudFile: Object of uploaded file.
        """

        return Cloud(self).upload_file(fd)

    def get_grades(self) -> list[EduGrade]:
        """Get a list of all available grades.

        Returns:
            list[EduGrade]: List of `EduGrade`s.
        """

        return Grades(self).get_grades(year=None, term=None)

    def get_grades_for_term(self, year: int, term: Term) -> list[EduGrade]:
        """Get a list of all available grades for a given year and term

        Returns:
            list[EduGrade]: List of `EduGrade`s
        """

        return Grades(self).get_grades(year=year, term=term)

    def get_user_id(self) -> str:
        """Get your EduPage user ID.

        Returns:
            str: Your EduPage user ID.
        """

        return self.data.get("userid")

    def custom_request(
        self, url: str, method: str, data: str = "", headers: dict = {}
    ) -> Response:
        """Send custom request to EduPage.

        Args:
            url (str): URL endpoint.
            method (str): Method (`GET` or `POST`).
            data (str, optional): Request data. Defaults to `""`.
            headers (dict, optional): Request headers. Defaults to `{}`.

        Returns:
            Response: Response.
        """

        return CustomRequest(self).custom_request(url, method, data, headers)

    def get_missing_teachers(self, date: date) -> list[EduTeacher]:
        """Get missing teachers for a given date.

        Args:
            date (datetime.date): The date you want to get this information for.

        Returns:
            list[EduTeacher]: List of the missing teachers for `date`.
        """
        return Substitution(self).get_missing_teachers(date)

    def get_timetable_changes(self, date: date) -> list[TimetableChange]:
        """Get the changes in the timetable for a given date.

        Args:
            date (datetime.date): The date you want to get this information for.

        Returns:
            list[TimetableChange]: List of changes in the timetable.
        """
        return Substitution(self).get_timetable_changes(date)

    def get_school_year(self) -> int:
        """Returns the current school year.

        Returns:
            int: The starting year of the current school year.
        """
        return ForeignTimetables(self).get_school_year()

    def get_foreign_timetable(self, id: int, date: datetime) -> list[LessonSkeleton]:
        """Get someone else's timetable for the week `date` is in.

        Args:
            id (int): The `person_id` of the person whoose timetable you want.
            date (datetime.date): A date from the week from which you want this timetable.

        Returns:
            list[LessonSkeleton]: Lessons (in order) that this person has for `date`'s week.

        Note:
            This returns the whole timetable (lessons from 1 week, NOT 1 day)!
        """
        return ForeignTimetables(self).get_timetable_for_person(id, date)

    def get_next_ringing_time(self, date_time: datetime) -> RingingTime:
        """Get the next lesson's ringing time for given `date_time`.

        Args:
            date_time (datetime.datetime): The (date)time you want to get this information for.

        Returns:
            RingingTime: The type (break or lesson) and time of the next ringing.
        """
        return RingingTimes(self).get_next_ringing_time(date_time)

    def switch_to_child(self, child: Union[EduAccount, int]):
        """Switch to an account of a child - can only be used on parent accounts

        Args:
            child (EduAccount | int): The account or `person_id` of the child you want to switch to

        Note: When you switch to a child account, all other methods will return data as if you were logged in as `child`
        """
        Parent(self).switch_to_child(child)

    def switch_to_parent(self):
        """Switches back to your parent account - can only be used on parent accounts"""
        Parent(self).switch_to_parent()

    @classmethod
    def from_session_id(cls, session_id: str, subdomain: str):
        """Create an `Edupage` instance with a session id and subdomain.

        Args:
            session_id (str): The `PHPSESSID` cookie.
            subdomain (str): Subdomain of the school which cookie is from.

        Returns:
            Edupage: A new `Edupage` instance.
        """
        instance = cls()

        Login(instance).reload_data(subdomain, session_id)

        return instance

Sub-modules

edupage_api.cloud
edupage_api.compression
edupage_api.custom_request
edupage_api.dbi
edupage_api.exceptions
edupage_api.foreign_timetables
edupage_api.grades
edupage_api.login
edupage_api.lunches
edupage_api.messages
edupage_api.module
edupage_api.parent
edupage_api.people
edupage_api.ringing
edupage_api.substitution
edupage_api.timeline
edupage_api.timetables
edupage_api.utils

Classes

class Edupage (request_timeout=5)

Initialize Edupage object.

Args

request_timeout : int, optional: Length of request timeout in seconds. If want to upload bigger files, you will have to increase its value. Defaults to 5.

Expand source code

class Edupage(EdupageModule):
    def __init__(self, request_timeout=5):
        """Initialize `Edupage` object.

        Args:
            request_timeout (int, optional): Length of request timeout in seconds.
                If want to upload bigger files, you will have to increase its value.
                Defaults to `5`.
        """

        self.data = None
        self.is_logged_in = False
        self.subdomain = None
        self.gsec_hash = None
        self.username = None

        self.session = requests.session()
        self.session.request = functools.partial(
            self.session.request, timeout=request_timeout
        )

    def login(
        self, username: str, password: str, subdomain: str
    ) -> Optional[TwoFactorLogin]:
        """Login while specifying the subdomain to log into.

        Args:
            username (str): Your username.
            password (str): Your password.
            subdomain (str): Subdomain of your school (https://{subdomain}.edupage.org).

        Returns:
            Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
            or the `TwoFactorLogin` object that is used to complete 2fa.
        """

        return Login(self).login(username, password, subdomain)

    def login_auto(self, username: str, password: str) -> Optional[TwoFactorLogin]:
        """Login using https://portal.edupage.org. If this doesn't work, please use `Edupage.login`.

        Args:
            username (str): Your username.
            password (str): Your password.

        Returns:
            Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
            or the `TwoFactorLogin` object that is used to complete 2fa.
        """

        return Login(self).login(username, password)

    def get_students(self) -> Optional[list[EduStudent]]:
        """Get list of all students in your class.

        Returns:
            Optional[list[EduStudent]]: List of `EduStudent`s.
        """

        return People(self).get_students()

    def get_all_students(self) -> Optional[list[EduStudentSkeleton]]:
        """Get list of all students in your school.

        Returns:
            Optional[list[EduStudentSkeleton]]: List of `EduStudentSkeleton`s.
        """

        return People(self).get_all_students()

    def get_teachers(self) -> Optional[list[EduTeacher]]:
        """Get list of all teachers in your school.

        Returns:
            Optional[list[EduTeacher]]: List of `EduTeacher`s.
        """

        return People(self).get_teachers()

    def send_message(
        self, recipients: Union[list[EduAccount], EduAccount], body: str
    ) -> int:
        """Send message.

        Args:
            recipients (Optional[list[EduAccount]]): Recipients of your message (list of `EduAccount`s).
            body (str): Body of your message.

        Returns:
            int: The timeline id of the new message.
        """

        return Messages(self).send_message(recipients, body)

    def get_timetable(self, date: datetime) -> Optional[Timetable]:
        """Get timetable.

        Args:
            date (datetime): Date from which you want to get timetable.

        Returns:
            Optional[Timetable]: Timetable object for entered date.
        """

        return Timetables(self).get_timetable(date)

    def get_lunches(self, date: datetime) -> Optional[Lunch]:
        """Get lunches.

        Args:
            date (datetime): Date from which you want to get lunches.

        Returns:
            Optional[Lunch]: Lunch object for entered date.
        """

        return Lunches(self).get_lunch(date)

    def get_notifications(self) -> list[TimelineEvent]:
        """Get list of all available notifications.

        Returns:
            list[TimelineEvent]: List of `TimelineEvent`s.
        """

        return TimelineEvents(self).get_notifications()

    def cloud_upload(self, fd: TextIOWrapper) -> EduCloudFile:
        """Upload file to EduPage cloud.

        Args:
            fd (TextIOWrapper): File you want to upload.

        Returns:
            EduCloudFile: Object of uploaded file.
        """

        return Cloud(self).upload_file(fd)

    def get_grades(self) -> list[EduGrade]:
        """Get a list of all available grades.

        Returns:
            list[EduGrade]: List of `EduGrade`s.
        """

        return Grades(self).get_grades(year=None, term=None)

    def get_grades_for_term(self, year: int, term: Term) -> list[EduGrade]:
        """Get a list of all available grades for a given year and term

        Returns:
            list[EduGrade]: List of `EduGrade`s
        """

        return Grades(self).get_grades(year=year, term=term)

    def get_user_id(self) -> str:
        """Get your EduPage user ID.

        Returns:
            str: Your EduPage user ID.
        """

        return self.data.get("userid")

    def custom_request(
        self, url: str, method: str, data: str = "", headers: dict = {}
    ) -> Response:
        """Send custom request to EduPage.

        Args:
            url (str): URL endpoint.
            method (str): Method (`GET` or `POST`).
            data (str, optional): Request data. Defaults to `""`.
            headers (dict, optional): Request headers. Defaults to `{}`.

        Returns:
            Response: Response.
        """

        return CustomRequest(self).custom_request(url, method, data, headers)

    def get_missing_teachers(self, date: date) -> list[EduTeacher]:
        """Get missing teachers for a given date.

        Args:
            date (datetime.date): The date you want to get this information for.

        Returns:
            list[EduTeacher]: List of the missing teachers for `date`.
        """
        return Substitution(self).get_missing_teachers(date)

    def get_timetable_changes(self, date: date) -> list[TimetableChange]:
        """Get the changes in the timetable for a given date.

        Args:
            date (datetime.date): The date you want to get this information for.

        Returns:
            list[TimetableChange]: List of changes in the timetable.
        """
        return Substitution(self).get_timetable_changes(date)

    def get_school_year(self) -> int:
        """Returns the current school year.

        Returns:
            int: The starting year of the current school year.
        """
        return ForeignTimetables(self).get_school_year()

    def get_foreign_timetable(self, id: int, date: datetime) -> list[LessonSkeleton]:
        """Get someone else's timetable for the week `date` is in.

        Args:
            id (int): The `person_id` of the person whoose timetable you want.
            date (datetime.date): A date from the week from which you want this timetable.

        Returns:
            list[LessonSkeleton]: Lessons (in order) that this person has for `date`'s week.

        Note:
            This returns the whole timetable (lessons from 1 week, NOT 1 day)!
        """
        return ForeignTimetables(self).get_timetable_for_person(id, date)

    def get_next_ringing_time(self, date_time: datetime) -> RingingTime:
        """Get the next lesson's ringing time for given `date_time`.

        Args:
            date_time (datetime.datetime): The (date)time you want to get this information for.

        Returns:
            RingingTime: The type (break or lesson) and time of the next ringing.
        """
        return RingingTimes(self).get_next_ringing_time(date_time)

    def switch_to_child(self, child: Union[EduAccount, int]):
        """Switch to an account of a child - can only be used on parent accounts

        Args:
            child (EduAccount | int): The account or `person_id` of the child you want to switch to

        Note: When you switch to a child account, all other methods will return data as if you were logged in as `child`
        """
        Parent(self).switch_to_child(child)

    def switch_to_parent(self):
        """Switches back to your parent account - can only be used on parent accounts"""
        Parent(self).switch_to_parent()

    @classmethod
    def from_session_id(cls, session_id: str, subdomain: str):
        """Create an `Edupage` instance with a session id and subdomain.

        Args:
            session_id (str): The `PHPSESSID` cookie.
            subdomain (str): Subdomain of the school which cookie is from.

        Returns:
            Edupage: A new `Edupage` instance.
        """
        instance = cls()

        Login(instance).reload_data(subdomain, session_id)

        return instance

Ancestors

EdupageModule

Class variables

var data : dict
var gsec_hash : str
var is_logged_in : bool
var session : requests.sessions.Session
var subdomain : str
var username : str

Static methods

def from_session_id(session_id: str, subdomain: str)

Create an Edupage instance with a session id and subdomain.

Args

session_id : str: The PHPSESSID cookie.
subdomain : str: Subdomain of the school which cookie is from.

Returns

Edupage: A new Edupage instance.

Expand source code

@classmethod
def from_session_id(cls, session_id: str, subdomain: str):
    """Create an `Edupage` instance with a session id and subdomain.

    Args:
        session_id (str): The `PHPSESSID` cookie.
        subdomain (str): Subdomain of the school which cookie is from.

    Returns:
        Edupage: A new `Edupage` instance.
    """
    instance = cls()

    Login(instance).reload_data(subdomain, session_id)

    return instance

Methods

def cloud_upload(self, fd: _io.TextIOWrapper) ‑> EduCloudFile

Upload file to EduPage cloud.

Args

fd : TextIOWrapper: File you want to upload.

Returns

EduCloudFile: Object of uploaded file.

Expand source code

def cloud_upload(self, fd: TextIOWrapper) -> EduCloudFile:
    """Upload file to EduPage cloud.

    Args:
        fd (TextIOWrapper): File you want to upload.

    Returns:
        EduCloudFile: Object of uploaded file.
    """

    return Cloud(self).upload_file(fd)

def custom_request(self, url: str, method: str, data: str = '', headers: dict = {}) ‑> requests.models.Response

Send custom request to EduPage.

Args

url : str: URL endpoint.
method : str: Method (GET or POST).
data : str, optional: Request data. Defaults to "".
headers : dict, optional: Request headers. Defaults to {}.

Returns

Response: Response.

Expand source code

def custom_request(
    self, url: str, method: str, data: str = "", headers: dict = {}
) -> Response:
    """Send custom request to EduPage.

    Args:
        url (str): URL endpoint.
        method (str): Method (`GET` or `POST`).
        data (str, optional): Request data. Defaults to `""`.
        headers (dict, optional): Request headers. Defaults to `{}`.

    Returns:
        Response: Response.
    """

    return CustomRequest(self).custom_request(url, method, data, headers)

def get_all_students(self) ‑> Optional[list[EduStudentSkeleton]]

Get list of all students in your school.

Returns

Optional[list[EduStudentSkeleton]]: List of EduStudentSkeletons.

Expand source code

def get_all_students(self) -> Optional[list[EduStudentSkeleton]]:
    """Get list of all students in your school.

    Returns:
        Optional[list[EduStudentSkeleton]]: List of `EduStudentSkeleton`s.
    """

    return People(self).get_all_students()

def get_foreign_timetable(self, id: int, date: datetime.datetime) ‑> list[LessonSkeleton]

Get someone else's timetable for the week date is in.

Args

id : int: The person_id of the person whoose timetable you want.
date : datetime.date: A date from the week from which you want this timetable.

Returns

list[LessonSkeleton]: Lessons (in order) that this person has for date's week.

Note

This returns the whole timetable (lessons from 1 week, NOT 1 day)!

Expand source code

def get_foreign_timetable(self, id: int, date: datetime) -> list[LessonSkeleton]:
    """Get someone else's timetable for the week `date` is in.

    Args:
        id (int): The `person_id` of the person whoose timetable you want.
        date (datetime.date): A date from the week from which you want this timetable.

    Returns:
        list[LessonSkeleton]: Lessons (in order) that this person has for `date`'s week.

    Note:
        This returns the whole timetable (lessons from 1 week, NOT 1 day)!
    """
    return ForeignTimetables(self).get_timetable_for_person(id, date)

def get_grades(self) ‑> list[EduGrade]

Get a list of all available grades.

Returns

list[EduGrade]: List of EduGrades.

Expand source code

def get_grades(self) -> list[EduGrade]:
    """Get a list of all available grades.

    Returns:
        list[EduGrade]: List of `EduGrade`s.
    """

    return Grades(self).get_grades(year=None, term=None)

def get_grades_for_term(self, year: int, term: Term) ‑> list[EduGrade]

Get a list of all available grades for a given year and term

Returns

list[EduGrade]: List of EduGrades

Expand source code

def get_grades_for_term(self, year: int, term: Term) -> list[EduGrade]:
    """Get a list of all available grades for a given year and term

    Returns:
        list[EduGrade]: List of `EduGrade`s
    """

    return Grades(self).get_grades(year=year, term=term)

def get_lunches(self, date: datetime.datetime) ‑> Optional[Lunch]

Get lunches.

Args

date : datetime: Date from which you want to get lunches.

Returns

Optional[Lunch]: Lunch object for entered date.

Expand source code

def get_lunches(self, date: datetime) -> Optional[Lunch]:
    """Get lunches.

    Args:
        date (datetime): Date from which you want to get lunches.

    Returns:
        Optional[Lunch]: Lunch object for entered date.
    """

    return Lunches(self).get_lunch(date)

def get_missing_teachers(self, date: datetime.date) ‑> list[EduTeacher]

Get missing teachers for a given date.

Args

date : datetime.date: The date you want to get this information for.

Returns

list[EduTeacher]: List of the missing teachers for date.

Expand source code

def get_missing_teachers(self, date: date) -> list[EduTeacher]:
    """Get missing teachers for a given date.

    Args:
        date (datetime.date): The date you want to get this information for.

    Returns:
        list[EduTeacher]: List of the missing teachers for `date`.
    """
    return Substitution(self).get_missing_teachers(date)

def get_next_ringing_time(self, date_time: datetime.datetime) ‑> RingingTime

Get the next lesson's ringing time for given date_time.

Args

date_time : datetime.datetime: The (date)time you want to get this information for.

Returns

RingingTime: The type (break or lesson) and time of the next ringing.

Expand source code

def get_next_ringing_time(self, date_time: datetime) -> RingingTime:
    """Get the next lesson's ringing time for given `date_time`.

    Args:
        date_time (datetime.datetime): The (date)time you want to get this information for.

    Returns:
        RingingTime: The type (break or lesson) and time of the next ringing.
    """
    return RingingTimes(self).get_next_ringing_time(date_time)

def get_notifications(self) ‑> list[TimelineEvent]

Get list of all available notifications.

Returns

list[TimelineEvent]: List of TimelineEvents.

Expand source code

def get_notifications(self) -> list[TimelineEvent]:
    """Get list of all available notifications.

    Returns:
        list[TimelineEvent]: List of `TimelineEvent`s.
    """

    return TimelineEvents(self).get_notifications()

def get_school_year(self) ‑> int

Returns the current school year.

Returns

int: The starting year of the current school year.

Expand source code

def get_school_year(self) -> int:
    """Returns the current school year.

    Returns:
        int: The starting year of the current school year.
    """
    return ForeignTimetables(self).get_school_year()

def get_students(self) ‑> Optional[list[EduStudent]]

Get list of all students in your class.

Returns

Optional[list[EduStudent]]: List of EduStudents.

Expand source code

def get_students(self) -> Optional[list[EduStudent]]:
    """Get list of all students in your class.

    Returns:
        Optional[list[EduStudent]]: List of `EduStudent`s.
    """

    return People(self).get_students()

def get_teachers(self) ‑> Optional[list[EduTeacher]]

Get list of all teachers in your school.

Returns

Optional[list[EduTeacher]]: List of EduTeachers.

Expand source code

def get_teachers(self) -> Optional[list[EduTeacher]]:
    """Get list of all teachers in your school.

    Returns:
        Optional[list[EduTeacher]]: List of `EduTeacher`s.
    """

    return People(self).get_teachers()

def get_timetable(self, date: datetime.datetime) ‑> Optional[Timetable]

Get timetable.

Args

date : datetime: Date from which you want to get timetable.

Returns

Optional[Timetable]: Timetable object for entered date.

Expand source code

def get_timetable(self, date: datetime) -> Optional[Timetable]:
    """Get timetable.

    Args:
        date (datetime): Date from which you want to get timetable.

    Returns:
        Optional[Timetable]: Timetable object for entered date.
    """

    return Timetables(self).get_timetable(date)

def get_timetable_changes(self, date: datetime.date) ‑> list[TimetableChange]

Get the changes in the timetable for a given date.

Args

date : datetime.date: The date you want to get this information for.

Returns

list[TimetableChange]: List of changes in the timetable.

Expand source code

def get_timetable_changes(self, date: date) -> list[TimetableChange]:
    """Get the changes in the timetable for a given date.

    Args:
        date (datetime.date): The date you want to get this information for.

    Returns:
        list[TimetableChange]: List of changes in the timetable.
    """
    return Substitution(self).get_timetable_changes(date)

def get_user_id(self) ‑> str

Get your EduPage user ID.

Returns

str: Your EduPage user ID.

Expand source code

def get_user_id(self) -> str:
    """Get your EduPage user ID.

    Returns:
        str: Your EduPage user ID.
    """

    return self.data.get("userid")

def login(self, username: str, password: str, subdomain: str) ‑> Optional[TwoFactorLogin]

Args

username : str: Your username.
password : str: Your password.
subdomain : str: Subdomain of your school (https://{subdomain}.edupage.org).

Returns

Optional[TwoFactorLogin]: Returns None if no second factor was needed to login,

or the TwoFactorLogin object that is used to complete 2fa.

Expand source code

def login(
    self, username: str, password: str, subdomain: str
) -> Optional[TwoFactorLogin]:
    """Login while specifying the subdomain to log into.

    Args:
        username (str): Your username.
        password (str): Your password.
        subdomain (str): Subdomain of your school (https://{subdomain}.edupage.org).

    Returns:
        Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
        or the `TwoFactorLogin` object that is used to complete 2fa.
    """

    return Login(self).login(username, password, subdomain)

def login_auto(self, username: str, password: str) ‑> Optional[TwoFactorLogin]

Args

username : str: Your username.
password : str: Your password.

Returns

Optional[TwoFactorLogin]: Returns None if no second factor was needed to login,

or the TwoFactorLogin object that is used to complete 2fa.

Expand source code

def login_auto(self, username: str, password: str) -> Optional[TwoFactorLogin]:
    """Login using https://portal.edupage.org. If this doesn't work, please use `Edupage.login`.

    Args:
        username (str): Your username.
        password (str): Your password.

    Returns:
        Optional[TwoFactorLogin]: Returns `None` if no second factor was needed to login,
        or the `TwoFactorLogin` object that is used to complete 2fa.
    """

    return Login(self).login(username, password)

def send_message(self, recipients: Union[list[EduAccount], EduAccount], body: str) ‑> int

Send message.

Args

recipients : Optional[list[EduAccount]]: Recipients of your message (list of EduAccounts).
body : str: Body of your message.

Returns

int: The timeline id of the new message.

Expand source code

def send_message(
    self, recipients: Union[list[EduAccount], EduAccount], body: str
) -> int:
    """Send message.

    Args:
        recipients (Optional[list[EduAccount]]): Recipients of your message (list of `EduAccount`s).
        body (str): Body of your message.

    Returns:
        int: The timeline id of the new message.
    """

    return Messages(self).send_message(recipients, body)

def switch_to_child(self, child: Union[EduAccount, int])

Switch to an account of a child - can only be used on parent accounts

Args

child (EduAccount | int): The account or person_id of the child you want to switch to Note: When you switch to a child account, all other methods will return data as if you were logged in as child

Expand source code

def switch_to_child(self, child: Union[EduAccount, int]):
    """Switch to an account of a child - can only be used on parent accounts

    Args:
        child (EduAccount | int): The account or `person_id` of the child you want to switch to

    Note: When you switch to a child account, all other methods will return data as if you were logged in as `child`
    """
    Parent(self).switch_to_child(child)

def switch_to_parent(self)

Switches back to your parent account - can only be used on parent accounts

Expand source code

def switch_to_parent(self):
    """Switches back to your parent account - can only be used on parent accounts"""
    Parent(self).switch_to_parent()