Skip to content

Yunding-Tech/ITYUT

Repository files navigation

ITYUT

一个用于连接TYUT并获取相关信息的开发工具

  License jdk   springboot

前言

本项目参考自PYTYUT,在该项目基础上使用Java重构,更改了一些实现,并提供了一些新的功能,该项目仍在完善中,后续会进行优化并添加新功能

环境安装

!!! 使用前请确保您拥有权限安装软件包,具体请参考 GitHub Packages

将该存储库添加到pom中

    <repositories>
        <repository>
            <id>github</id>
            <name>GitHub OWNER Apache Maven Packages</name>
            <url>https://maven.pkg.github.com/ruafafa/ITYUT</url>
        </repository>
        ...
    </repositories>

使用maven安装

    <dependency>
      <groupId>fun.ruafafa</groupId>
      <artifactId>ityut-spring-boot3-starter</artifactId>
      <version>1.1</version> 
    </dependency>

基本使用

ITYUT 的使用十分简单,以登录为例,您只需要:

ITyutUtil.login("YOUR_ACCOUNT", "YOUR_PASSWORD");

即可完成登录,您可以在登录后使用:

ITyutUtil.isLogin("YOUR_ACCOUNT"); 

该方法将返回一个布尔值,用于判断是否登录成功,当然,您可能会觉得每次都需要传入账号密码十分麻烦,您可以使用提供的代理类来接收 login 返回的结果,并使用代理类来完成 ITyutUtil 能完成的所有功能(除登录外):

ITyutUtilProxy user = ITyutUtil.login("YOUR_ACCOUNT", "YOUR_PASSWORD");
user.isLogin();

如果您想要登出账号,您可以使用:

// 代理对象
user.logout();
// 指定账户
ITyutUtil.logout("USER_ACCOUNT");

当您登录成功后,就可以使用其他功能了

功能

通过 ITyutUtil 或者其代理对象的 Api,您可以做到:

  • 登录
  • 登出
  • 获取GPA等
  • 获取考试成绩
  • 获取班级课表
  • 获取学年学期
  • 获取考试安排
  • 获取教学建筑
  • 获取考试成绩
  • 获取学生信息
  • 一键教评
  • 选课

自动配置

当前版本默认引入了 4 个访问节点,其中 Ruafafa-JWC 节点无需连接校园网即可使用,其余节点需要自行连接TYUT校园网使用,不用就保证节点可用性, 一些默认节点可能会在后续版本中被修改或删除,如果您需要使用其他节点,请参考 下文引入自定义节点,您引入的节点将被优先选择

ityut:
  cutomNodes:
    - xxxxxxxx
    - ....

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages