Bewerbung Generator Documentation

🚀 Bewerbung Generator v1.0.3

Professional German Job Application Generator with AI Support

Welcome to the Bewerbung Generator v|version| documentation! This tool generates professional German job applications using AI-powered content generation with multiple provider support.

Note

Current Version: 1.0.3 | Release: 1.0.3

📋 View the changelog for recent updates and improvements.

System Workflow

📊 Interactive Diagram: View System Workflow

The application generation follows a structured 7-step process from cache clearing through PDF conversion.

AI Provider Selection

📊 Interactive Diagram: View AI Provider Selection

The system uses intelligent multi-provider fallback with automatic provider switching for reliable content generation.

User Guide

• Installation
  • Requirements
  • System Dependencies
  • Installation Steps
  • AI Provider Setup
  • Quick Setup Script
  • Troubleshooting
  • Next Steps
• Quick Start
  • Prerequisites
  • Your First Application
  • Understanding the Output Structure
  • Using Different AI Providers
  • Advanced Generation Options
  • Testing Your Setup
  • Understanding Generated Content
  • Regeneration Scripts
  • Next Steps
  • Common Issues
• Configuration
  • Environment Variables
  • File Organization Patterns
  • Template Configuration
  • AI Provider Settings
  • Logging Configuration
  • Advanced Configuration
  • Configuration Validation
  • Environment File Examples
• Tutorials
  • Tutorial 1: Basic Application Generation
  • Tutorial 2: Comparing AI Providers
  • Tutorial 3: Advanced Output Organization
  • Tutorial 4: Custom Template Development
  • Tutorial 5: Automated Testing Workflow
  • Tutorial 6: Performance Optimization
  • Tutorial 7: Troubleshooting Common Issues
  • Next Steps

API Reference

• API Reference
  • Core Modules
  • AI Clients
  • Analysis and Testing
  • Utilities
  • Module Index

Development

• Architecture
  • System Overview
  • High-Level Architecture
  • Core Components
  • Data Flow
  • Design Patterns
  • Module Dependencies
  • Configuration Management
  • Error Handling Strategy
  • Testing Strategy
  • Performance Considerations
  • Security Considerations
  • Future Architecture Enhancements

Testing & Quality

• Test Coverage Reports
  • Coverage Overview
  • Current Coverage Status
  • Running Coverage Tests
  • Coverage Configuration
  • Understanding Coverage Reports
  • Coverage Targets by Module
  • Improving Coverage
  • CI/CD Integration
  • Coverage Best Practices
  • Related Resources

Features

✨ Multi-Provider AI Support

Support for Claude API, Ollama/Llama, and sample content fallback

🏗️ Directory-Only Organization

Clean structure with AI provider subdirectories, no root files

📚 Comprehensive Documentation

Auto-generated README files and regeneration scripts for each output

🔄 Regeneration Testing

Automated validation that regeneration scripts work correctly

📊 Content Variants Analysis

Compare AI-generated content across different providers

🧪 Comprehensive Test Coverage

View Coverage Reports - Track code quality with detailed test coverage analysis

🗃️ Structured Logging

Detailed logs for each generation process

Quick Start

1. Installation:

   git clone https://github.com/thsetz/Bewerbung.git
   cd Bewerbung
   make install
   

2. Configuration:

   cp .env.example .env
   # Edit .env with your AI provider API keys
   

3. Generate Application:

   make generate
   

4. View Results:

   ls Ausgabe/
   

Architecture Overview

The Bewerbung Generator follows a modular architecture:

• AI Client Factory: Manages multiple AI providers with fallback support

• Template Manager: Handles Jinja2 templates for document generation

• Content Variants Analyzer: Compares content across providers

• Documentation Generator: Creates comprehensive documentation

• Regeneration Tester: Validates script reproducibility

Supported AI Providers

• Claude API: Professional-grade content generation

• Ollama/Llama: Local AI models for privacy-focused generation

• Sample Content: Built-in fallback for reliable operation

Indices and tables

• Index

• Module Index

• Search Page