# FOSS_ToolKit

**Repository Path**: rtos_yuan/FOSS_ToolKit

## Basic Information

- **Project Name**: FOSS_ToolKit
- **Description**: 开源小工具FOSS_ToolKit
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-05-12
- **Last Updated**: 2023-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OSS Audit Tool

#### 介绍
仓库运维管理开源脚本工具



#### 环境准备

`FOSS_ToolKit`是Python脚本工具，需要安装Python。有关Python安装的信息，请访问[https://www.python.org/](https://gitee.com/link?target=https%3A%2F%2Fwww.python.org%2F)获取。

1. 克隆或下载脚本代码

   访问https://gitee.com/rtos_yuan/FOSS_ToolKit进行克隆或者下载。

2. 安装Python三方包

   `FOSS_ToolKit`工具依赖一些Python三方包，在使用工具前，需要确保已经安装了依赖的Python三方包。如果没有安装，在`FOSS_ToolKit`目录，进入命令行终端，执行`pip install -r requirements.txt`需要安装依赖的三方包，只需要执行一次，如果已经安装依赖的三方包，则不需要执行。

3. 配置token信息于工具根目录下的`config.toml`文件

   访问[Gitee OpenAPI](https://gitee.com/api/v5/swagger)，点击右上角的申请授权按钮申请，把申请到的`access_token`替代文件中的"Please input your own token"，需要保留双引号。

   ```
   gitee_token= "Please replace this with your own token"
   ```



#### 使用说明

- 合规文件审计工具

  **用途**：用于检查指定文件是否存在于组织下的特定仓库的主目录下

  **工具位置**：`FOSS_ToolKit\tool\file_existence_check.py`模块

  **配置项**：配置`FOSS_ToolKit\config.toml`中`file_to_check`列表项，用于指定需要检查的文件

  ```
  file_to_check = [
   'OAT.xml',
   'README.OpenSource',
  ]
  ```

  **运行方式**：直接运行模块中，如下方法

  ```python
  # 示例：检测openharmony组织下，三方仓库中，config.toml指定文件，是否存在
  audit_files_existence_in_remote_main_directory('openharmony', repo_filter=only_third_party_repo)
  ```

  

- 仓库设置修改工具

  **用途**：用于单仓或批量修改仓库设置

  **工具位置**：`FOSS_ToolKit\tool\repo_setting_modifier.py`模块

  **配置项**：配置`FOSS_ToolKit\config.toml`文件

  - `repo_setting`字典项，用于指定需要修改的设置

    ```
    [repo_setting]
    security_hole_enabled = "true"
    issue_template_source = "project"
    ```

  - `repo_no_need_to_change_setting`列表项，用于指定跳过修改的仓库名（无跳过项，则无需修改）

    ```
    repo_no_need_to_change_setting = [
      'replace this with skiped_repo_plain_name',
    ]
    ```

  **运行方式**：直接运行模块中，如下方法

  - 修改单仓设置

    ```python
    # 示例：修改openharmony组织下，docs仓库的设置，为config.toml中指定项
    modify_repo_func_setting('openharmony', 'docs')
    ```

  - 批量修改组织仓库设置

    ```python
    # 示例：修改openharmony组织下，所有仓库的设置，为config.toml中指定项
    modify_org_repos_func_setting('openharmony', repo_filter=is_repo_need_to_modify)
    ```

    > 进阶：依循策略模式，可以通过扩展`is_repo_need_to_modify`，自行选择仓库过滤项

  

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request