# 配置采集插件

**Repository Path**: canway-code/cc-plugin-workspace

## Basic Information

- **Project Name**: 配置采集插件
- **Description**: cmdb配置采集插件框架，纳管江南农商行CMDB与黑盒可观测项目所需的配置采集插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-09
- **Last Updated**: 2026-08-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cc-plugin-workspace

这是一个配置发现插件开发的工作区，推荐开发者使用此项目作为载体开发插件，以便于统一管理和维护。
cc-plugin-fixture作为依赖已被此项目引入，开发者可以直接使用fixture进行插件开发。

## 如何使用

### 安装环境依赖

- python > 3.11, <3.12

### 安装环境依赖

```bash
pip install -r requirements.txt
```

### 配置环境变量

- 参考scripts/envir/里面的两个模板文件
    - 当联动的蓝鲸环境是3.x、4.0，复制[env.example_paasv2](scripts/envir/env.example_paasv2)
      文件，重命名为.env.{PAAS_LABEL}.env文件，如联动paas.dev.com环境，则命名为env.dev.env
    - 当联动的蓝鲸环境是5.x，复制[env.example_paasv3](scripts/envir/env.example_paasv3)文件，重命名为.env.{PAAS_LABEL}.env文件
- 在项目根目录创建local_settings.py文件，内容如下：

```python
import os

MODULE_DIR = os.path.dirname(os.path.abspath(__file__))
# scripts/dev/envs.dev.env修改为你具体的环境变量文件名
ENV_FILE_PATH = os.path.join(MODULE_DIR, 'scripts/envir/envs.dev.env')
```

请不要修改BKAPP_PLUGIN_TEMPLATE_DIST_DIR、BKAPP_PLUGIN_PACKAGE_DIST_DIR和BKAPP_PLUGIN_PRODUCT_DIST_DIR的默认值，因为这些目录已写入.gitignore文件中忽略

### 初始化项目目录

此操作会自动创建必须的文件目录

```commandline
python init.py
```

### 配置pre-commit

此项目使用pre-commit进行代码规范检查，要激活它们，需要在项目根目录运行

```bash
pre-commit install
```
请自觉遵守代码规范，不要因为规范问题导致插件开发成本增高

## 如何进行插件开发

参考[如何利用fixture开发一个插件](docs/如何利用fixture开发一个插件.md)