# bore-app-template

**Repository Path**: sunspace/bore-app-template

## Basic Information

- **Project Name**: bore-app-template
- **Description**: 般若自动化平台机器人模版
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-05-30
- **Last Updated**: 2023-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 机器人APP模版使用说明


## 1 将整个代码仓库下载到本地目录
## 2 阅读示例代码：apps.ramdom-number
进入apps/random-number目录下，查看目录文件
**首先声明这是一个Python代码模块，由四个文件组成**
**__init__.py**: **必须文件** python模块默认文件，不需要做任何修改，默认创建此文件即可
**app.py**: **必须文件** 此文件中的代码将会被平台调用，并进行相关任务的执行
**config.json**:  **必须文件** 请参考配置文件内容

## 3 config.json文件说明
```json
{
  "envs": {},                                            # 默认为空，预留字段，不需要处理但是需要保留
  "source_kw": [],                                       # 需要APP.__init__传递的参数，这个参数会在平台机器人APP的资源配置中进行配置，方便后续快速选择使用
  "actions": {                                           # 平台解析此对象下的数据进行执行
    "生产随机数字": {                                      # 此机器人APP支持的动作，最好是固定后续不再更换
      "verbose_name": "生产随机数字",                      # 动作名称，需要简洁明了，最好中文方便快速理解
      "help_text": "生产随机数字",                         # 此动作的详细解释，建议尽量简单，不需要太复杂，如果很复杂建议提炼，更详细的放入到readme.md文件中单独解释
      "class_name": "App",                               # app.py中的调用的类的名称，所有的动作都必须放入类中调用，可以自定义，如果App调用时__init__有初始化参数，请在source_kw中提供
      "func_name": "create_random_number",               # class_name中的func名称，最终被平台调用的方法
      "input_kwargs": [                                  # func需要的参数
        { 
          "name": "min_number",                          # 字段名称，func中传递的参数名称
          "verbose_name": "最小数",                       # 参数名称解释，中文
          "type": "number",                              # 字段类型：number、int、str、txt、json、set、list
          "default": 0                                   # 默认值
        },
        {
          "name": "max_number",
          "verbose_name": "最大数",
          "type": "number",
          "default": 10
        }
      ],
      "output_kwargs": [
        {
          "name": "num",
          "verbose_name": "随机数",
          "type": "number"
        }
      ]
    },
    "生成指定范围内的数字列表": {
      "verbose_name": "生成指定范围内的数字列表",
      "help_text": "给定数字范围，按小到大依次返回数字",
      "class_name": "App",
      "func_name": "range_number",
      "input_kwargs": [
        {
          "name": "start",
          "verbose_name": "最小数",
          "type": "number",
          "default": 0
        },
        {
          "name": "stop",
          "verbose_name": "最大数",
          "type": "number",
          "default": 10
        }
      ],
      "output_kwargs": [
        {
          "name": "num",
          "verbose_name": "数字",
          "type": "number"
        }
      ]
    }
  }
}

```