Skip to content

Commit

Permalink
update: doc improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
williamfzc committed Mar 10, 2019
1 parent c02c6e7 commit 6ff0f2a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@
```python
from pyatool import PYAToolkit

# 初始化
device = PYAToolkit('123456F')

# 直接调用
# 1. 直接调用
package_list = device.show_package()
# 通过标准库(有自动补全)
# 2. 或者 通过标准库(有自动补全,能够看到真实的方法实现
package_list = device.std.show_package(toolkit=device)

# 具体返回内容与调用的方法实现有关
print(package_list)
```

Expand Down Expand Up @@ -103,14 +105,7 @@ device_toolkit.download_and_install()

pyatool如此设计的目的是为了能够尽量减少重复工作。为了方便所有人加入开发,往内置库中添加方法非常容易。

如果你编写了一些好方法并希望将其合入pyatool内置库以方便后续使用,你只需要:

- 直接在github上编辑`extras.py`
- 将写好的函数按照格式粘贴到`extras.py`
-`__all__`中加入你的函数名称
- 描述你的修改,然后点击`Propose file change`,github会自动为你发起pull request

要让库变得更方便好用还是需要各位的共同努力~
如果你编写了一些好方法并希望将其合入pyatool标准库以方便后续使用,你只需要将你的方法添加到 `extras.py` 中,发起PR!

## 具体案例

Expand Down Expand Up @@ -142,11 +137,6 @@ when_connect(device='all', do=install_sh)

就完成了。在运行之后,一旦有android设备接入,将会自动为其安装apk。

## TODO

- [ ] 用subprocess调用adb的方式依旧不够科学,参考[socket2adb](https://github.com/williamfzc/socket2adb)
- [ ] 标准函数库因为动态绑定导致在IDE中没有自动补全

## 意见与建议

欢迎issue与PR
Expand Down
7 changes: 7 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ Directly call standard API.
```python
from pyatool import PYAToolkit

# init
device = PYAToolkit('123456F')

# 1. call it directly
package_list = device.show_package()
# 2. or, call it via std
package_list = device.std.show_package(toolkit=device)

# return content depends on called function
print(package_list)
```

Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ Usage

from pyatool import PYAToolkit

# 初始化
device = PYAToolkit('123456F')

# 直接调用
# 1. 直接调用
package_list = device.show_package()
# 通过标准库(有自动补全)
# 2. 或者 通过标准库(有自动补全,能够看到真实的方法实现
package_list = device.std.show_package(toolkit=device)

# 具体返回内容与调用的方法实现有关
print(package_list)

要调用其他的API,将 `show_package` 替换成API名称即可!
Expand Down

0 comments on commit 6ff0f2a

Please sign in to comment.