| Name | alist3 JSON |
| Version |
1.4.1
JSON |
| download |
| home_page | None |
| Summary | AList V3 PythonSDK |
| upload_time | 2025-07-20 08:42:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | LGPL 2.1 |
| keywords |
alist
pythonsdk
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AList3SDK
[](https://alist3sdk.readthedocs.io/zh-cn/latest/?badge=latest)
[!WARNING]
本SDK默认API已切换为异步API,若需要使用同步API,请使用`AListSync`和`AListAdminSync`，或安装`1.3.2`及以下的版本
AList3SDK 是一个高性能的 Python SDK，用于与 AList 服务轻松交互 🚀。它支持异步和同步 API ⚡，并提供完善的类型注解 📝，让开发更高效！
## 安装
您可以使用 pip 安装 AList3SDK：
```bash
pip install alist3
```
## 快速开始
使用 AList3SDK，您可以轻松地与 AList 服务进行交互。以下是一个快速示例：
```python
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())
```
## 示例代码
有关示例代码，请参阅我们的 [文档📄](https://alist3sdk.readthedocs.io/examples)。
## API 文档
请参阅我们的 [文档📄](https://alist3sdk.readthedocs.io)。
## 常见问题解答
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): 增加对上传字节数据和文件指针的支持
- 1.3.7 (2025-03-29): 修复issue:[#6](https://github.com/moyanj/AList3SDK/issues/6)
- 1.3.8 (2025-05-01): 添加网络代理设置:[#8](https://github.com/moyanj/AList3SDK/issues/8)
- 1.4.0 (2025-07-20): 适配更多api
- 1.4.1 (2025-07-20): 修复类型注释并清理代码
Raw data
{
"_id": null,
"home_page": null,
"name": "alist3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "AList, PythonSDK, API",
"author": null,
"author_email": "MoYan <moyanjdc@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/93/d1/749866721ff06302c25db2dc2f7796f786a592619284cd2bfb8f3f0938f4/alist3-1.4.1.tar.gz",
"platform": null,
"description": "# AList3SDK\n\n\n\n\n\n[](https://alist3sdk.readthedocs.io/zh-cn/latest/?badge=latest)\n\n[!WARNING]\n\u672cSDK\u9ed8\u8ba4API\u5df2\u5207\u6362\u4e3a\u5f02\u6b65API,\u82e5\u9700\u8981\u4f7f\u7528\u540c\u6b65API,\u8bf7\u4f7f\u7528`AListSync`\u548c`AListAdminSync`\uff0c\u6216\u5b89\u88c5`1.3.2`\u53ca\u4ee5\u4e0b\u7684\u7248\u672c\n\nAList3SDK \u662f\u4e00\u4e2a\u9ad8\u6027\u80fd\u7684 Python SDK\uff0c\u7528\u4e8e\u4e0e AList \u670d\u52a1\u8f7b\u677e\u4ea4\u4e92 \ud83d\ude80\u3002\u5b83\u652f\u6301\u5f02\u6b65\u548c\u540c\u6b65 API \u26a1\uff0c\u5e76\u63d0\u4f9b\u5b8c\u5584\u7684\u7c7b\u578b\u6ce8\u89e3 \ud83d\udcdd\uff0c\u8ba9\u5f00\u53d1\u66f4\u9ad8\u6548\uff01\n\n## \u5b89\u88c5\n\n\u60a8\u53ef\u4ee5\u4f7f\u7528 pip \u5b89\u88c5 AList3SDK\uff1a\n\n```bash\npip install alist3\n```\n\n## \u5feb\u901f\u5f00\u59cb\n\n\u4f7f\u7528 AList3SDK\uff0c\u60a8\u53ef\u4ee5\u8f7b\u677e\u5730\u4e0e AList \u670d\u52a1\u8fdb\u884c\u4ea4\u4e92\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u5feb\u901f\u793a\u4f8b\uff1a\n\n```python\nimport asyncio\nfrom alist import AList, AListUser\n\n# \u521d\u59cb\u5316 AList3SDK \u5ba2\u6237\u7aef\nuser = AListUser(\"<your-user-name>\", \"<your-password>\") # \u7528\u6237\u540d\u548c\u5bc6\u7801\nclient = AList(\"<your-server-url>\") # \u670d\u52a1\u5668 URL\n\nasync def main():\n # \u767b\u5f55\n await client.login(user)\n \n # \u5217\u51fa\u6307\u5b9a\u76ee\u5f55\u4e0b\u7684\u6587\u4ef6\n res = await client.list_dir(\"/test\")\n \n # \u6253\u5370\u76ee\u5f55\u5185\u5bb9\n async for item in res:\n print(item)\n\n# \u8fd0\u884c\u5f02\u6b65\u4efb\u52a1\nasyncio.run(main())\n\n```\n\n## \u793a\u4f8b\u4ee3\u7801\n\n\u6709\u5173\u793a\u4f8b\u4ee3\u7801\uff0c\u8bf7\u53c2\u9605\u6211\u4eec\u7684 [\u6587\u6863\ud83d\udcc4](https://alist3sdk.readthedocs.io/examples)\u3002\n\n## API \u6587\u6863\n\u8bf7\u53c2\u9605\u6211\u4eec\u7684 [\u6587\u6863\ud83d\udcc4](https://alist3sdk.readthedocs.io)\u3002\n\n\n## \u5e38\u89c1\u95ee\u9898\u89e3\u7b54\n\nQ: \u5982\u679c\u9047\u5230\u8eab\u4efd\u9a8c\u8bc1\u95ee\u9898\u5e94\u8be5\u600e\u4e48\u529e\uff1f\n\nA: \u8bf7\u786e\u4fdd\u60a8\u7684 AList\u5730\u5740\u548c\u8d26\u53f7\u5bc6\u7801\u6b63\u786e\uff0c\u5e76\u5177\u6709\u8db3\u591f\u7684\u6743\u9650\u3002\n\n## \u8d21\u732e\u6307\u5357\n\n\u6211\u4eec\u6b22\u8fce\u793e\u533a\u8d21\u732e\u8005\u4e3a\u6539\u8fdb\u548c\u5b8c\u5584 AList3SDK \u505a\u51fa\u8d21\u732e\u3002\u5982\u679c\u53d1\u73b0\u4efb\u4f55 bug \u6216\u6709\u65b0\u7684\u529f\u80fd\u5efa\u8bae\uff0c\u8bf7\u63d0\u4ea4 issue \u6216 PR\u3002\n\n## \u7248\u672c\u5386\u53f2\n\n- 1.0.0 (2024-02-16): \u521d\u59cb\u7248\u672c\u53d1\u5e03\u3002\n- 1.1 (2024-05-10) : \u6539\u4e86\u4e00\u5927\u5806\u4e1c\u897f\n- 1.1.1 (2024-05-20)\uff1a \u4fee\u6539\u6587\u6863\u4e0e\u4fee\u590dbug\n- 1.1.2 (2024-07-04)\uff1a\u9002\u914d\u90e8\u5206admin\u64cd\u4f5c,\u6dfb\u52a0\u4e00\u591a\u7ebf\u7a0b\u4e0b\u8f7d\u5668\n- 1.1.3 (2024-07-05): \u66f4\u65b0\u6587\u6863\uff0c\u589e\u52a0\u7528\u6237\u7c7b\u52a0\u8f7d\n- 1.1.4 (2024-08-11): \u4fee\u590d\u5df2\u77e5\u95ee\u9898\uff0c\u4f18\u5316\u7528\u6237\u4f53\u9a8c\n- 1.2.0 (2024-11-04): \u4fee\u6539\u5927\u91cf\u547d\u540d\u98ce\u683c\n- 1.3.0 (2024-11-09): \u589e\u52a0\u5f02\u6b65\u652f\u6301\n- 1.3.1 (2024-11-09): \u4fee\u590d\u5df2\u77e5\u95ee\u9898\uff0c\u4f18\u5316\u7528\u6237\u4f53\u9a8c\n- 1.3.2 (2024-11-15): \u6dfb\u52a0\u7c7b\u578b\u6ce8\u89e3\n- 1.3.3 (2024-11-15): \u5207\u6362\u9ed8\u8ba4api\u81f3\u5f02\u6b65\n- 1.3.4 (2024-12-29): \u4fee\u590d\u5df2\u77e5\u95ee\u9898\uff0c\u652f\u6301\u7528\u6237\u7ba1\u7406\n- 1.3.5 (2025-01-22): \u4fee\u590dAListFile\u81ea\u52a8\u4e0b\u8f7d\u95ee\u9898\n- 1.3.6 (2025-03-07): \u589e\u52a0\u5bf9\u4e0a\u4f20\u5b57\u8282\u6570\u636e\u548c\u6587\u4ef6\u6307\u9488\u7684\u652f\u6301\n- 1.3.7 (2025-03-29): \u4fee\u590dissue:[#6](https://github.com/moyanj/AList3SDK/issues/6)\n- 1.3.8 (2025-05-01): \u6dfb\u52a0\u7f51\u7edc\u4ee3\u7406\u8bbe\u7f6e:[#8](https://github.com/moyanj/AList3SDK/issues/8)\n- 1.4.0 (2025-07-20): \u9002\u914d\u66f4\u591aapi\n- 1.4.1 (2025-07-20): \u4fee\u590d\u7c7b\u578b\u6ce8\u91ca\u5e76\u6e05\u7406\u4ee3\u7801\n",
"bugtrack_url": null,
"license": "LGPL 2.1",
"summary": "AList V3 PythonSDK",
"version": "1.4.1",
"project_urls": null,
"split_keywords": [
"alist",
" pythonsdk",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "af21097b773aef65e5b6f0499bfac03798c8e100bad7bc94694a980bdf53eeab",
"md5": "06aebfe195ffba6f082ea249315672b2",
"sha256": "7474a8f3285277f96e6a7b5ad6b59e757b7fb25d40790de501dc9e9a063bb844"
},
"downloads": -1,
"filename": "alist3-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06aebfe195ffba6f082ea249315672b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20272,
"upload_time": "2025-07-20T08:42:58",
"upload_time_iso_8601": "2025-07-20T08:42:58.758799Z",
"url": "https://files.pythonhosted.org/packages/af/21/097b773aef65e5b6f0499bfac03798c8e100bad7bc94694a980bdf53eeab/alist3-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "93d1749866721ff06302c25db2dc2f7796f786a592619284cd2bfb8f3f0938f4",
"md5": "c6dfad95332ef968b97461bce25cc010",
"sha256": "b48aac6a95b3f1fd4c750b17535f8217670c1ab5b0b0c29ba84cd836d44ba07f"
},
"downloads": -1,
"filename": "alist3-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "c6dfad95332ef968b97461bce25cc010",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 18801,
"upload_time": "2025-07-20T08:42:59",
"upload_time_iso_8601": "2025-07-20T08:42:59.709375Z",
"url": "https://files.pythonhosted.org/packages/93/d1/749866721ff06302c25db2dc2f7796f786a592619284cd2bfb8f3f0938f4/alist3-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-20 08:42:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "alist3"
}
