diff --git a/README.md b/README.md index 5f7e6cf..f460baf 100644 --- a/README.md +++ b/README.md @@ -18,29 +18,66 @@ - **报告生成**: 自动生成详细的检测报告,列出所有发现的敏感操作和对应的风险等级。 - **持续更新与维护**: 随着新的后门技术和检测方法的出现,持续更新正则表达式库和评级标准。 +## 打包 + +### pip + +#### 打包命令 + +```bash +pip install wheel +python setup.py sdist bdist_wheel +``` + +执行上述命令后,会在 dist 目录下生成 .tar.gz 和 .whl 文件。 + +#### 本地安装 + +- 安装 .whl 文件: + +``` bash +pip install dist/backdoor_buster-0.1.0-py3-none-any.whl +``` + +- 安装 .tar.gz 文件: + +``` bash +pip install dist/backdoor_buster-0.1.0.tar.gz +``` + +#### 上传到 PyPI + +- 安装 twine: + +``` bash +pip install twine +``` + +- 使用 twine 上传包到 PyPI: + +``` bash +twine upload dist/* +``` + +需要提供 PyPI 的用户名和密码。如果没有 PyPI 账号,可以在 PyPI 注册。 + +#### 使用 PyPI 安装 + +包上传到 PyPI 后,可以通过以下命令安装: + +``` bash +pip install backdoor_buster +``` + ## 使用说明 -1. 安装依赖: - - ```bash - pip install -r requirements.txt - ``` - -2. 执行扫描: - - 未打包: - - ```bash - python /detection/__main__.py -o -m - ``` - - 打包后: +1. 执行扫描: ```bash python -m detection -o -m ``` -3. 查看报告: +2. 查看报告: 报告将以文本形式输出在控制台,并可选择输出到指定文件。