Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lemisky committed Dec 21, 2023
1 parent 2db997a commit 0e06520
Showing 1 changed file with 41 additions and 54 deletions.
95 changes: 41 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
>
> 附带一份文档 [阿里云盘开放平台文档](https://www.yuque.com/aliyundrive/zpfszx/fitzlb1uyy0pv0iw)
## 安装

[![python version](https://img.shields.io/pypi/pyversions/aligo)](https://pypi.org/project/aligo/) [![Downloads](https://static.pepy.tech/personalized-badge/aligo?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/aligo)

```sh
Expand All @@ -26,12 +28,13 @@ from aligo import Aligo

if __name__ == '__main__':
ali = Aligo() # 第一次使用,会弹出二维码,供扫描登录

user = ali.get_user() # 获取用户信息
print(user.user_name, user.nick_name, user.phone) # 打印用户信息

ll = ali.get_file_list() # 获取网盘根目录文件列表
for file in ll: # 遍历文件列表

file_list = ali.get_file_list() # 获取网盘根目录文件列表
for file in file_list: # 遍历文件列表
# 注意:print(file) 默认只显示部分信息,但是实际上file有很多的属性
print(file.file_id, file.name, file.type) # 打印文件信息
```

Expand All @@ -57,49 +60,40 @@ https://user-images.githubusercontent.com/35125624/150529002-c2f1b80b-fb11-4e0a-
- [x] 获取帐户、云盘(容量)等基本信息
- [x] 相册 创建 删除 修改 添加文件 获取文件

更多接口功能,请安装最新版尝试

欢迎大家发起 [新功能请求](https://github.com/foyoux/aligo/issues/new?assignees=&labels=&template=feature_request.md&title=)

> **温馨提示:**
> 1. 由于秒传链接的失效,自定分享信息的有效期只有4个小时。
> 2. 阿里云盘不同于其他网盘或系统,其定位文件不是基于文件名(路径),而是通过 `file_id`,这才是唯一定位文件的方式,**aligo** 中提供了简便函数 `get_file_by_path`/`get_folder_by_path`,通过网盘路径获取文件对象,通过 其上的 `file_id` 属性即可获取所需文件标识。但不建议频繁使用此方法,因为内部是通过 `get_file_list` 遍历得到的。
> 3. 在保存超大分享时(分享中的文件特别多),执行保存全部的方法 - `share_file_save_all_to_drive`,它会立刻执行完毕,但是文件不会立刻被保存到网盘中,阿里云盘服务器会帮你在后台陆续将所有文件存到你的网盘中;所有当你使用 `share_file_save_all_to_drive` 保存超大分享时,却只看到一部分文件时,不用疑惑,这是正常情况。
> **Notes:**
> 1. 由于秒传链接的失效,自定分享信息的有效期只有4个小时。
> 2. 阿里云盘不同于其他网盘或系统,其定位文件不是基于文件名(路径),而是通过 `file_id`,这才是唯一定位文件的方式,**aligo** 中提供了简便函数 `get_file_by_path`/`get_folder_by_path`,通过网盘路径获取文件对象,通过 其上的 `file_id` 属性即可获取所需文件标识。但不建议频繁使用此方法,因为内部是通过 `get_file_list` 遍历得到的。
> 3. 在保存超大分享时(分享中的文件特别多),执行保存全部的方法 - `share_file_save_all_to_drive`,它会立刻执行完毕,但是文件不会立刻被保存到网盘中,阿里云盘服务器会帮你在后台陆续将所有文件存到你的网盘中;所有当你使用 `share_file_save_all_to_drive` 保存超大分享时,却只看到一部分文件时,不用疑惑,这是正常情况。
## 登录
### 网页扫码登录

```python
from aligo import Aligo

# 提供 port 参数即可, 之后打开浏览器访问 http://<YOUR_IP>:<port>
ali = Aligo(port=8080)
```


### 发送登录二维码到邮箱(推荐)

**最佳实践**:建议将邮箱绑定到微信,这样能实时收到提醒,登录过期后也可以第一时间收到登录请求。

```python
from aligo import Aligo, EMailConfig
1. 网页扫码登录

if __name__ == '__main__':
email_config = EMailConfig(
email='<接收登录邮件的邮箱地址>',
# 自配邮箱
user='',
password='',
host='',
port=0,
)
ali = Aligo(email=email_config)
```
```python
from aligo import Aligo

# 提供 port 参数即可, 之后打开浏览器访问 http://<YOUR_IP>:<port>
ali = Aligo(port=8080)
```

## 如何彻底删除文件?
> 无需先移动文件到回收站
2. 发送登录二维码到邮箱(推荐)

此功能太危险,**aligo** 未直接提供。不过 [这里](https://github.com/foyoux/aligo/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E5%8A%9F%E8%83%BD---%E5%BD%BB%E5%BA%95%E5%88%A0%E9%99%A4%E6%96%87%E4%BB%B6) 扩展了该功能,请小心使用!
**最佳实践**:建议将邮箱绑定到微信,这样能实时收到提醒,登录过期后也可以第一时间收到登录请求。

```python
from aligo import Aligo, EMailConfig

if __name__ == '__main__':
email_config = EMailConfig(
email='<接收登录邮件的邮箱地址>',
# 自配邮箱
user='',
password='',
host='',
port=0,
)
ali = Aligo(email=email_config)
```

## 如何操作资源盘

Expand All @@ -114,10 +108,9 @@ if __name__ == '__main__':
resource_drive_id = v2_user.resource_drive_id
# 如果后续默认操作资源盘
# ali.default_drive_id = resource_drive_id
ll = ali.get_file_list(drive_id=resource_drive_id)
for i in ll:
print(i)

file_list = ali.get_file_list(drive_id=resource_drive_id)
for file in file_list:
print(file)
```

## 如何自定义配置文件路径
Expand All @@ -130,7 +123,6 @@ if __name__ == '__main__':
set_config_folder('/home/aligo')
# 会创建 /home/aligo/一号服务器.json 配置文件
ali = Aligo(name='一号服务器')

```

## 关于扩展功能
Expand All @@ -146,15 +138,10 @@ if __name__ == '__main__':
[扩展功能举栗🌰 - 配有视频和代码](https://github.com/foyoux/aligo/issues/24)


## 不慎泄露 refresh_token ?

虽然官方提供下线功能,但还是要 马上修改密码

今天无意中发现,之前使用 aligo 登录的会在登录设备列表中,但今天发现再使用 aligo 登录,已经不会出现在登录设备列表中,我也不知道为什么

今天把除我手机之外的所有设备下线后,包括 Chrome 和 aligo 登录的,但并没有失效,所有的 token 和 refresh_token 还是可以使用
## 如何彻底删除文件?
> 无需先移动文件到回收站
所以还是得 -> 必须马上修改密码!必须马上修改密码!必须马上修改密码
此功能太危险,**aligo** 未直接提供。不过 [这里](https://github.com/foyoux/aligo/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E5%8A%9F%E8%83%BD---%E5%BD%BB%E5%BA%95%E5%88%A0%E9%99%A4%E6%96%87%E4%BB%B6) 扩展了该功能,请小心使用


## 声明
Expand Down

0 comments on commit 0e06520

Please sign in to comment.