.. toctree::
   :maxdepth: 2
   :caption: 目录:

   installation
   usage
   api/modules
   exceptions

欢迎使用 gduter-py
=======================

这是一个用于与广东工业大学相关系统进行交互的 Python 库。
目前支持统一身份认证平台和教务系统的常用操作。

安装
====

可以通过 git 安装：

.. code-block:: bash

   pip install git+https://github.com/GDUTMeow/gduter-py

快速上手
========
 
以下是一个简单的示例，展示如何使用 `LoginClient` 和 `AcademicAffairsOfficeClient` 登录并获取课表：

.. code-block:: python

   from gduter.client import LoginClient, AcademicAffairsOfficeClient

   def main():
       login_client = LoginClient()
       try:
           login_client.login("学号", "密码")
           print("统一身份认证平台登录成功！")

           academic_client = AcademicAffairsOfficeClient(login_client=login_client)
           academic_client.login()
           print("教务系统登录成功！")

           # 获取 2024-2025 学年第一学期的课表
           courses = academic_client.get_course_schedule(202401)
           if courses:
               print("成功获取课表：")
               for course in courses:
                   print(f"- {course['course_name']} ({course['teacher_name']})")
           else:
               print("该学期没有课程。")

       except Exception as e:
           print(f"发生错误: {e}")

   if __name__ == "__main__":
       main()

请将 "学号" 和 "密码" 替换为你的实际登录凭证。

贡献
====

欢迎提交 issue 和 pull request！

联系方式
========

GamerNoTitle@outlook.com