湘潭大学校园网 API

安装

从 PyPI 安装：

pip install xtu-network

从 GitHub 安装：

pip install git+https://github.com/xtu-hit/xtu-network-python.git@main#egg=xtu-network

示例

简单代码示例

from xtu.network import XtuNetwork
from xtu.network import NoLoginError
from xtu.network import OnlineUserInfo

async def main():
    async with XtuNetwork(202400001111, "rsa_password") as xtu:
        print(await xtu.login())
        print(await xtu.checkOnline())

        print(await xtu.getErrorMsg())
        print(res := await xtu.getOnlineUserInfo())

        print(OnlineUserInfo.get_online_count_from_ball_info(res["ballInfo"]))

        print(await xtu.checkNetwork())

        try:
            print(await xtu.logout())
        except NoLoginError:
            pass

详见 example.py 用法

说明

XtuNetwork 类用于连接校园网。
getErrorMsg() 乍一看是获取错误信息，实际上什么也不返回，但是不调用此 API 的话 getOnlineUserInfo 就无法正确返回。
getOnlineUserInfo() 用于获取在线用户信息，返回一个字典。
checkNetwork() 用于检查网络状态，返回一个布尔值。
logout() 用于退出校园网，无返回值，如果尚未登录则抛出 NoLoginError 异常。

如何获得 RSA 加密后的密码？

使用 security.html 获取，或者 F12 查看校园网登录请求。

开源协议

本仓库使用 AGPL-3.0 协议，注意事项：

源代码共享义务：使用或修改此软件进行开发或提供网络服务时，必须提供完整的源代码。
网络应用条款：若通过网络向用户提供此程序的功能，必须确保用户能够获取到相应的源代码。
许可证继承：任何分发的修改版必须继续使用AGPL-3.0许可证，确保后续版本的开放性和共享要求。
修改版标识：任何分发的修改版本须在显著位置标明已修改，并附上具体修改的内容和日期。
专利权警示：使用此软件即表明你接受并遵循软件中规定的专利权限。
免责条款：软件按“现状”提供，不提供任何明示或暗示的保证。使用软件所产生的任何风险由用户自行承担。

Metadata

Release files for xtu-network 0.0.29

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xtu-network 0.0.29
File	Size	Uploaded
xtu_network-0.0.29.tar.gz	12.8 kB	Mar 26, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for xtu-network 0.0.29
File	Interpreter	ABI	Platform	Reset
xtu_network-0.0.29-py3-none-any.whl 12.7 kB Mar 26, 2025	Python 3	none	any	Details

Total release size: 25.5 kB

Release files / xtu_network-0.0.29.tar.gz

Download URL	xtu_network-0.0.29.tar.gz
Size	12.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`47ea4be512e927c1f044edf9b27b441b9a787aebfccf21e9973f46ec812590a3`
BLAKE2b-256 checksum How to use checksums	`104972229ef5391c61a98883c5fe33ee5e4c72e6de525b6b37447ef5111b42a4`
Upload date	Mar 26, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Release files / xtu_network-0.0.29-py3-none-any.whl

Download URL	xtu_network-0.0.29-py3-none-any.whl
Size	12.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c348c40d88e0c2c4f2bc4030509cc4ae7e9cb465c0abdd69f3de9ab9f1a761a5`
BLAKE2b-256 checksum How to use checksums	`19750b23106746ae7ccb10e3e44c5de9fd076b6469e2a4c0f5acd6e86d1f2037`
Upload date	Mar 26, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.9`