A powerful Python-based Manual Code Verification Assistant for efficient and accurate review of programmatically generated code snippets.

Transform your code review workflow with both modern GUI and interactive terminal interfaces that make comparing generated code against expected results fast, intuitive, and comprehensive.

Current Version: 0.1.0 (Alpha) - Active development with regular updates

• Python 3.8+ 🐍 (Python 3.10+ recommended)
• Git for cloning the repository

# Clone the repository
git clone https://github.com/netpack/vaitp-auditor.git
cd vaitp-auditor

# Create and activate a Python virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install with GUI support
pip install -e ".[gui]"

# Run the application
vaitp-auditor

# macOS users: For proper icon in dock, use the launcher instead:
python vaitp_auditor_launcher.py

GUI Mode (Default)

# Launch the modern desktop interface (default if GUI dependencies available)
vaitp-auditor

# macOS users: For proper custom icon in dock, use:
python vaitp_auditor_launcher.py
# Or explicitly request GUI mode
vaitp-auditor --gui

Terminal Mode

# Start terminal-based review session
vaitp-auditor --cli

Follow the interactive setup wizard:

1. Enter experiment name: my_first_review
2. Select data source: Choose from folders, SQLite, or Excel/CSV
3. Configure paths: Point to your generated and expected code
4. Set sampling: Choose percentage of data to review (1-100%)
5. Start reviewing: Use intuitive interface to classify code pairs

📁 Folder-based Review (Most Common)

vaitp-auditor
# Select option 1: Folders
# Generated code: /path/to/generated/
# Expected code: /path/to/expected/
# Original input code: /path/to/input/

🗄️ Database Review

# SQLite database with code_pairs table
# Columns: id, generated_code, expected_code

📊 Excel/CSV Review

# Spreadsheet with columns:
# ID | Generated Code | Expected Code

Navigation (CLI Mode)

• ↑↓←→ or hjkl - Scroll through code
• Tab - Switch between panels
• Page Up/Down - Navigate faster

Classification (Single keypress!)

• s - Success ✅ (Code works correctly)
• f - Failure ❌ (Code doesn't work)
• i - Invalid 🚫 (Syntax errors)
• w - Wrong ⚠️ (Wrong vulnerability type)
• p - Partial 🔶 (Partially correct)
• u - Undo ↩️ (Go back one step)
• q - Quit 🚪 (Save and exit)

• Setup Wizard: Intuitive 5-step configuration process
• Side-by-Side Code Comparison: Syntax highlighting with diff visualization
• Responsive Interface: Smooth scrolling, keyboard shortcuts, and accessibility support
• Performance Optimized: Lazy loading for large files, intelligent caching
• Accessibility Features: Screen reader support, high contrast themes, keyboard navigation

• Side-by-side code comparison with syntax highlighting
• Smooth scrolling and navigation
• Progress tracking and session management

• File System: Compare folders of code files
• SQLite: Review code stored in databases
• Excel/CSV: Process spreadsheet data

• Auto-save progress after each review
• Resume interrupted sessions seamlessly
• 30-day automatic cleanup of old sessions

• Excel reports with rich formatting and metadata
• CSV exports for further analysis
• Detailed timing and diff information

• Lazy loading for large files (>100KB)
• Intelligent caching and memory management
• Chunked processing for massive datasets
• Real-time performance monitoring

VAITP-Auditor automatically manages session files, but you can manually clean up when needed:

# View session files
ls -la ~/.vaitp_auditor/sessions/

# Remove sessions older than 7 days (automatic cleanup is 30 days)
find ~/.vaitp_auditor/sessions/ -name "*.pkl" -mtime +7 -delete

# Remove all session files (⚠️ careful!)
rm ~/.vaitp_auditor/sessions/*.pkl

• Sessions: Auto-deleted after 30 days
• Logs: Rotated automatically
• Reports: Never auto-deleted (your data!)

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Data Sources  │    │   UI Components │    │   Processing    │
│                 │    │                 │    │                 │
│ • File System   │───▶│ • Terminal UI   │───▶│ • Diff Engine   │
│ • SQLite DB     │    │ • Syntax Highl. │    │ • Classification│
│ • Excel/CSV     │    │ • Navigation    │    │ • Validation    │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         ▼                       ▼                       ▼
┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│ Session Manager │    │ Report Generator│    │ Performance     │
│                 │    │                 │    │                 │
│ • Auto-save     │    │ • Excel Export  │    │ • Memory Mgmt   │
│ • Resume        │    │ • CSV Export    │    │ • Caching       │
│ • Recovery      │    │ • Metadata      │    │ • Optimization  │
└─────────────────┘    └─────────────────┘    └─────────────────┘

We welcome contributions! Here's how to get started:

1. Fork the repository on GitHub
2. Clone your fork: git clone https://github.com/yourusername/vaitp-auditor.git
3. Create a feature branch: git checkout -b feature/amazing-feature
4. Install development dependencies: pip install -e .[dev]
5. Make your changes and add tests
6. Run tests: pytest
7. Commit your changes: git commit -m 'Add amazing feature'
8. Push to the branch: git push origin feature/amazing-feature
9. Open a Pull Request

• Follow PEP 8 style guidelines
• Add tests for new functionality
• Update documentation as needed
• Ensure all tests pass before submitting
• Write clear, descriptive commit messages

See our Developer Guide for detailed contribution guidelines and architecture information.

This project is licensed under the MIT License - see the LICENSE file for details.

• ✅ Commercial use
• ✅ Modification
• ✅ Distribution
• ✅ Private use
• ❌ Liability
• ❌ Warranty

The MIT License is a permissive license that allows you to use this software for any purpose, including commercial applications, as long as you include the original copyright notice.

• 🚀 Fast: Optimized for large-scale code review workflows
• 🎯 Accurate: Structured classification with detailed reporting
• 💪 Robust: Cross-platform with comprehensive error handling
• 🔧 Flexible: Multiple data sources and export formats
• 📊 Insightful: Rich metadata and performance analytics

Ready to revolutionize your manual code review process? Get started in under 2 minutes! 🚀

VAITP-Auditor is currently in active development (v0.1.0 Alpha). The core functionality is stable and ready for use, with ongoing improvements to the GUI interface, performance optimizations, and deployment capabilities.

• ✅ Modern GUI interface with accessibility features
• ✅ Enhanced performance optimization and caching
• ✅ Comprehensive test suite with >80% coverage
• ✅ Simplified installation process

• 🔄 Enhanced reporting and analytics
• 🎨 Additional GUI themes and customization
• 📊 Advanced performance metrics and monitoring

• 📖 Documentation: Comprehensive guides in the docs/ directory

• 🐛 Issues: Report bugs and request features via GitHub Issues

• 💬 Discussions: Join community discussions for questions and ideas

• 📧 Contact: Reach out to the VAITP Research Team for collaboration

• Support my work on Patreon: https://www.patreon.com/user?u=62912574