Yaraflux

🚀 Yara Project Documentation Translation

Yara is a powerful tool that offers efficient solutions for threat intelligence. It simplifies the process of threat detection and analysis, enabling users to quickly identify potential threats.

🚀 Quick Start

📦 Installation

To install Yara, follow these steps:

1. Clone the repository:

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

2. Install dependencies:
   • For the development environment:

     make dev-setup
     

   • For the production environment, using Docker is recommended:

     docker-compose up --build
     

✨ Features

Yara provides a comprehensive set of features for threat intelligence, including easy installation, flexible usage with both basic and containerized options, detailed documentation, and a well - structured project layout. It also supports a smooth development and contribution process.

💻 Usage Examples

Basic Usage

To use Yara in your project, refer to the API Reference in the documentation.

Advanced Usage - Containerized Operation

Run Yara via Docker:

# Start the service
docker-compose up

# Stop the service
docker-compose down

# Rebuild the image
docker-compose build

# Execute unit tests
docker-compose run app pytest tests/

Code Example

from yara import YaraService

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

📚 Documentation

For the full documentation, please refer to Project Structure.

Project Structure

Here is the project's directory structure:

.
├── Dockerfile                     # Docker configuration file
├── entrypoint.sh                  # Container startup script
├── Makefile                       # Build automation script
├── pyproject.toml                 # Project metadata and dependencies
├── requirements.txt               # Core dependencies
└── requirements-dev.txt           # Development environment dependencies

🔧 Technical Details

Development

Environment Configuration

# Initialize the development environment
make dev-setup

# Execute tests
make test

# Run format checks
make lint format security-check

# Generate a coverage report
make coverage

CI/CD Workflow

The project uses GitHub Actions for continuous integration and deployment:

• CI Testing: Tests are run every time there is a push to the main or develop branch.
• Automatic Version Increment: The version number is automatically updated when pushing to the main branch.
• Release Build: A Docker image is generated and released.

🤝 Contribution Guidelines

Code Submission Specification

Please follow the following format when submitting code:

Type: Description
For example: feat: Add a new feature module
             fix: Fix a known issue

Development Process

1. Create a new branch:

   git checkout -b feature/new-feature main
   

2. Commit changes:

   git add .
   git commit -m "feat: Add a new feature module"
   

3. Push to the remote repository and create a Pull Request.

📄 License

This project is licensed under the MIT License. For details, please see the LICENSE file.

For more information, please visit the GitHub repository or contact the project maintainers.