Yara 项目文档翻译

安装

要安装Yara，请按照以下步骤操作：

1. 克隆仓库：

   git clone https://github.com/Threat情报/yara.git
   cd yara
   

2. 安装依赖项：

   • 对于开发环境：

     make dev-setup
     

   • 对于生产环境，推荐使用 Docker：

     docker-compose up --build
     

使用

基本用法

要在项目中使用Yara，请参考文档中的API 参考。

容器化运行

通过 Docker 运行：

# 启动服务
docker-compose up

# 停止服务
docker-compose down

# 重新构建镜像
docker-compose build

# 执行单元测试
docker-compose run app pytest tests/

文档

完整的文档内容请参考项目结构。

示例

from yara import YaraService

service = YaraService()
result = service.scan_file("example.exe")
print(result)

项目结构

以下是项目的目录结构：

.
├── Dockerfile                     # Docker 配置文件
├── entrypoint.sh                  # 容器启动脚本
├── Makefile                       # 构建自动化脚本
├── pyproject.toml                 # 项目元数据和依赖项
├── requirements.txt               # 核心依赖项
└── requirements-dev.txt           # 开发环境依赖项

开发

环境配置

# 初始化开发环境
make dev-setup

# 执行测试
make test

# 运行格式检查
make lint format security-check

# 生成覆盖率报告
make coverage

CI/CD 工作流程

项目使用 GitHub Actions 进行持续集成和部署：

• CI 测试：在每次推送到主分支或 develop 分支时运行测试。
• 版本自动递增：在推送至主分支时自动更新版本号。
• 发布构建：生成并发布的 Docker 镜像。

贡献指南

提交代码规范

请遵循以下格式提交代码：

类型: 描述
例如: feat: 新增功能模块
      fix: 修复已知问题

开发流程

1. 创建新分支：

   git checkout -b feature/new-feature main
   

2. 提交更改：

   git add .
   git commit -m "feat: 新增功能模块"
   

3. 推送至远程仓库并创建 Pull Request。

许可证

本项目遵循 MIT 协议。详情请查看LICENSE文件。

如需了解更多信息，请访问GitHub 仓库或联系项目维护者。