Yaraflux

🚀 Yara プロジェクトドキュメント翻訳

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/

コード例

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 リポジトリを参照するか、プロジェクトのメンテナに連絡してください。