.windsurfrules

# .windsurfrules

## Code Style and Organization

### File Structure
```
project/
├── agents/
│   ├── __init__.py
│   ├── base_agent.py
│   └── platform_specific/
│       ├── __init__.py
│       ├── facebook_agents.py
│       ├── google_agents.py
│       └── tiktok_agents.py
├── config/
│   ├── __init__.py
│   └── settings.py
├── utils/
│   ├── __init__.py
│   ├── api_handlers.py
│   └── data_processors.py
├── tests/
│   └── test_agents.py
└── main.py
```

### Code Style Rules
```python
# Maximum line length
max_line_length = 88

# Import order
import_order = [
    "standard_library",
    "third_party",
    "first_party",
    "local_folder"
]

# Class structure
class_structure = {
    "order": [
        "constants",
        "class_attributes",
        "init",
        "properties",
        "public_methods",
        "private_methods"
    ]
}

# Function length
max_function_length = 50

# Class length
max_class_length = 300

# File length
max_file_length = 500
```

### Naming Conventions
```python
# Classes
class_naming = "PascalCase"

# Functions and variables
function_naming = "snake_case"

# Constants
constant_naming = "UPPER_SNAKE_CASE"

# Private methods and variables
private_naming = "_leading_underscore"
```

### Documentation Requirements
```python
# Docstring format
docstring_format = "Google"

# Required docstring sections
docstring_sections = [
    "Args",
    "Returns",
    "Raises",
    "Examples"
]

# Inline comments
comment_rules = {
    "when": "complex_logic_only",
    "style": "clear_and_concise"
}
```

### Testing Requirements
```python
# Test coverage
min_test_coverage = 80

# Test naming
test_naming = "test_[function_name]_[scenario]"

# Test organization
test_structure = {
    "arrange": "setup_test_data",
    "act": "execute_function",
    "assert": "verify_results"
}
```

### Error Handling
```python
# Exception hierarchy
exception_structure = {
    "base": "CustomBaseException",
    "specific": "[Feature]Exception"
}

# Logging requirements
logging_levels = {
    "debug": "detailed_information",
    "info": "general_operations",
    "warning": "potential_issues",
    "error": "operation_failures",
    "critical": "system_failures"
}
```

### Performance Guidelines
```python
# Memory usage
max_memory_usage = {
    "process": "1GB",
    "function": "100MB"
}

# Processing time
max_processing_time = {
    "api_call": "5s",
    "data_processing": "10s",
    "report_generation": "30s"
}
```

### Security Rules
```python
# API handling
api_security = {
    "rate_limiting": True,
    "retry_strategy": "exponential_backoff",
    "authentication": "oauth2"
}

# Data handling
data_security = {
    "encryption": "required",
    "pii_handling": "masked",
    "data_retention": "compliance_based"
}
```

### Code Quality Checks
```python
# Required tools
quality_tools = [
    "black",
    "flake8",
    "mypy",
    "pylint",
    "bandit"
]

# Pre-commit hooks
pre_commit_checks = [
    "format_check",
    "lint_check",
    "type_check",
    "security_check"
]
```

### Dependency Management
```python
# Requirements
dependency_management = {
    "tool": "poetry",
    "version_pinning": True,
    "security_scanning": True
}

# Version control
version_control = {
    "branch_naming": "feature/[ticket_number]-[description]",
    "commit_message": "[ticket_number]: [description]"
}
```