Yaraflux

🚀 Yara 項目文檔翻譯

本項目提供 Yara 的相關功能，幫助用戶進行特定的威脅情報處理等工作，通過安裝和使用 Yara 可滿足不同環境下的業務需求。

🚀 快速開始

要使用 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/

Python 代碼示例

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 倉庫或聯繫項目維護者。