alist3

AList3SDK

[!WARNING] 本SDK默认API已切换为异步API,若需要使用同步API,请使用AListSync和AListAdminSync，或安装1.3.2及以下的版本

AList3SDK 是一个高性能的 Python SDK，用于与 AList 服务轻松交互 🚀。它支持异步和同步 API ⚡，并提供完善的类型注解 📝，让开发更高效！

安装

您可以使用 pip 安装 AList3SDK：

pip install alist3

快速开始

使用 AList3SDK，您可以轻松地与 AList 服务进行交互。以下是一个快速示例：

import asyncio
from alist import AList, AListUser

# 初始化 AList3SDK 客户端
user = AListUser("<your-user-name>", "<your-password>")  # 用户名和密码
client = AList("<your-server-url>")  # 服务器 URL

async def main():
    # 登录
    await client.login(user)
    
    # 列出指定目录下的文件
    res = await client.list_dir("/test")
    
    # 打印目录内容
    async for item in res:
        print(item)

# 运行异步任务
asyncio.run(main())

示例代码

有关示例代码，请参阅我们的 文档📄。

API 文档

请参阅我们的 文档📄。

常见问题解答

Q: 如果遇到身份验证问题应该怎么办？

A: 请确保您的 AList地址和账号密码正确，并具有足够的权限。

贡献指南

我们欢迎社区贡献者为改进和完善 AList3SDK 做出贡献。如果发现任何 bug 或有新的功能建议，请提交 issue 或 PR。

版本历史

• 1.0.0 (2024-02-16): 初始版本发布。
• 1.1 (2024-05-10) : 改了一大堆东西
• 1.1.1 (2024-05-20)： 修改文档与修复bug
• 1.1.2 (2024-07-04)：适配部分admin操作,添加一多线程下载器
• 1.1.3 (2024-07-05): 更新文档，增加用户类加载
• 1.1.4 (2024-08-11): 修复已知问题，优化用户体验
• 1.2.0 (2024-11-04): 修改大量命名风格
• 1.3.0 (2024-11-09): 增加异步支持
• 1.3.1 (2024-11-09): 修复已知问题，优化用户体验
• 1.3.2 (2024-11-15): 添加类型注解
• 1.3.3 (2024-11-15): 切换默认api至异步
• 1.3.4 (2024-12-29): 修复已知问题，支持用户管理
• 1.3.5 (2025-01-22): 修复AListFile自动下载问题
• 1.3.6 (2025-03-07): 增加对上传字节数据和文件指针的支持