Skip to content

Commit

Permalink
0.36.15:
Browse files Browse the repository at this point in the history
    1. 实现CLI命令行工具 alist-cli,可以快速登录、列出文件
    2. 细节日志优化
    3. 全局超时时间增加到30秒
    4. 修复AlistPath.__repl__ 在相对目录时报错的问题。
    5. 在pyproject.toml中为alist-cli提供命令行入口。
    6. 实现更多命令行工具,上传、下载、删除、创建目录, 打印文本文件。
    7. 在README中添加CLI命令行工具的使用说明。
  • Loading branch information
lee-cq committed Sep 16, 2024
1 parent e26efa6 commit 621463a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Alist API 简单封装
## [Alist API 文档](https://alist.nn.ci/zh/guide/api/)

## 安装

从PyPI安装最新release版本
`pip install alist-sdk`

Expand All @@ -18,11 +19,12 @@ Alist API 简单封装
```python
# Sync 模式
from alist_sdk import Client

client = Client(
base_url='http://localhost:5244',
username="",
password="",
token="", # 与 Username Password 二选一
token="", # 与 Username Password 二选一
)

client.me()
Expand All @@ -47,6 +49,7 @@ asyncio.run(client.me())
像使用pathlib一样操作Alist上的文件。
但是需要注意的是,AlistPath全部使用的同步方法(与Pathlib API保持一致)。
如果需要异步操作,可以使用`asyncio.to_thread`将同步方法转为异步方法。

```python
from alist_sdk.path_lib import login_server, AlistPath

Expand All @@ -61,4 +64,24 @@ path.stat()
path.is_dir()
path.read_text()
path.iterdir()
```

## 命令行工具 [开发中]

Alist SDK 提供了2个命令行工具,可以方便的操作Alist。

1. `alist-cli`:命令行工具,可以快速的操作Alist。
2. `alist-fs`:(`alist-cli fs` 的别名)文件相关操作,包括上传、下载、删除、查看文件信息等。

```
Usage: alist-cli [OPTIONS] COMMAND [ARGS]...
Options:
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help
Commands:
│ admin 管理命令 │
│ auth Authentication commands. │
│ fs 文件系统相关操作
```
3 changes: 2 additions & 1 deletion alist_sdk/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,9 @@
4. 修复AlistPath.__repl__ 在相对目录时报错的问题。
5. 在pyproject.toml中为alist-cli提供命令行入口。
6. 实现更多命令行工具,上传、下载、删除、创建目录, 打印文本文件。
7. 在README中添加CLI命令行工具的使用说明。
"""

__version__ = "0.36.15-a6"
__version__ = "0.37.15"

ALIST_VERSION = "v3.37.2"

0 comments on commit 621463a

Please sign in to comment.