工具类接口¶
- mini.pkg_tool.setup_py_pkg(project_dir: str) str[源代码]¶
将一个py工程打包成一个.whl文件。
- 参数:
project_dir – 工程文件根目录
- 返回:
生成的.whl文件绝对路径
- 返回类型:
str
- mini.pkg_tool.install_py_pkg(package_path: str, robot_id: str, debug: bool = False)[源代码]¶
将一个py程序安装包,安装到指定序列号的机器人上。
- 参数:
package_path – 安装包的绝对路径
robot_id – 机器人序列号
debug – 是否打印在机器人端卸载pkg时的log
- 返回:
None
- mini.pkg_tool.uninstall_py_pkg(pkg_name: str, robot_id: str, debug: bool = False)[源代码]¶
- 将一个安装的py程序,从指定序列号的机器人上卸载掉,例如有一个py程序,它的setup.py文件, 配置如下:
setuptools.setup(
name=”tts_demo”,
…#省略
),
那么,它的pkg_name为”tts_demo”。
- 参数:
pkg_name – 程序名称
robot_id – 机器人序列号
debug – 是否打印在机器人端卸载pkg时的log
- 返回:
None
- mini.pkg_tool.query_py_pkg(pkg_name: str, robot_id: str) str[源代码]¶
查询机器人上pkg_name指定的py程序, 其详细信息, 例如有一个py程序,它的setup.py文件, 配置如下:
setuptools.setup(
name=”tts_demo”,
version=”0.0.2”,
author=’Gino Deng’,
author_email=’jingjing.deng@ubtrobot.com’,
description=”demo with mini_sdk”,
long_description=’demo with mini_sdk,xxxxxxx’,
long_description_content_type=”text/markdown”,
license=”GPLv3”,
packages=setuptools.find_packages(),
classifiers=[
“Programming Language :: Python :: 3”,
“Programming Language :: Python :: 3.6”,
“Programming Language :: Python :: 3.7”,
“Programming Language :: Python :: 3.8”,
“License :: OSI Approved :: MIT License”,
“Operating System :: OS Independent”,
],
install_requires=[
‘alphamini’,
],
),
查询时, 指定pkg_name=”tts_demo”, 返回信息如下:
Name: tts-demo
Version: 0.0.2
Summary: demo with mini_sdk
Home-page: UNKNOWN
Author: Gino Deng
Author-email: jingjing.deng@ubtrobot.com
License: GPLv3
Location: /data/data/com.termux/files/usr/lib/python3.8/site-packages
Requires: alphamini
Required-by:
- 参数:
pkg_name – py程序名,
robot_id – 机器人序列号
- 返回:
安装包相信信息
- 返回类型:
str
- mini.pkg_tool.list_py_pkg(robot_id: str) str[源代码]¶
列出机器人上安装的py程序, 例如:
Package Version
———- ——-
alphamini 1.1.1
ifaddr 0.1.7
pip 20.1.1
protobuf 3.12.2
setuptools 47.3.1
six 1.15.0
tts-demo 0.0.2
websockets 8.1
wheel 0.34.2
- 参数:
robot_id – 机器人序列号
- 返回:
所有py程序名称-版本号
- 返回类型:
str
- mini.pkg_tool.run_py_pkg(entry_point: str, robot_id: str, debug: bool = False)[源代码]¶
触发一个指定的py程序, 在指定的机器人上运行。:
- 参数:
entry_point –
py程序console scripts名称, 例如在setup.py文件中,如配置 entry_points={
‘console_scripts’: [
‘XXX = Packages.Modules:XXX’
],
}, 程序入口名称为xxx
robot_id – 机器人序列号
debug – 是否回传程序执行时日志
- 返回:
None