Skip to main content

AListV3 PythonSDK

Project description

AList3SDK

PyPI - Downloads PyPI - Version GitHub Repo stars GitHub last commit GitHub License Documentation Status

[!WARNING] 本SDK默认API已切换为异步API,若需要使用同步API,请使用AListSyncAListAdminSync,或安装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至异步

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alist3-1.3.3.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

alist3-1.3.3-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file alist3-1.3.3.tar.gz.

File metadata

  • Download URL: alist3-1.3.3.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for alist3-1.3.3.tar.gz
Algorithm Hash digest
SHA256 8a30e33928b3753f69fea989d007f8d817d287a577253873dea02c3b34be04a4
MD5 6ebb94ef797dfd0749ce8a11355a1c5f
BLAKE2b-256 68c689bc6272cb66408defb671be00a18cb97f209734559cddc5f03f5500303b

See more details on using hashes here.

File details

Details for the file alist3-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: alist3-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for alist3-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9d6035e9de5fee8f803b490564f57e686ce20d8e0d55349e2d4d9546609b7d9d
MD5 fd0dfa48649e0888f21d9bbec01b5e24
BLAKE2b-256 1dccca7e1153815aee80d708234afb4b8e20ef35ed69d18bf7f7ea7b4e7e4ad6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page