popat

Name	popat JSON
Version	0.1.3 JSON
	download
home_page	https://github.com/An1rud/popat
Summary	Intelligent Terminal Error Helper - Advanced error detection and analysis for developers
upload_time	2025-09-07 07:03:50
maintainer	None
docs_url	None
author	Anirudh Sajith
requires_python	>=3.7
license	MIT
keywords	error debugging humor terminal ai assistant
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Popat - The Intelligent Terminal Error Helper

**Advanced error detection and analysis for developers**

Popat is an intelligent coding assistant that automatically intercepts programming errors and provides helpful, context-aware responses to enhance debugging efficiency and reduce development time.

## What Makes Popat Special?

Popat transforms the debugging experience by providing an intelligent assistant that watches your code, catches every error, and responds with personalized guidance. Whether you're a beginner learning to code or an experienced developer working on complex projects, Popat transforms frustrating error messages into clear, actionable insights.

## Key Features

- **Automatic Error Detection**: Runs silently in background, catching errors from 25+ programming languages
- **5 Response Personalities**: Choose your debugging companion (Encouraging, Sarcastic, Educational, Professional, Silly)
- **Adaptive Learning**: Gets smarter about your coding patterns and provides personalized assistance
- **Universal Shell Integration**: Works seamlessly with bash, zsh, fish, PowerShell, and cmd
- **Comprehensive Language Support**: Deep error pattern recognition for Python, JavaScript, Rust, Java, C++, Go, and more
- **Progress Tracking**: Monitors error patterns, learning progress, and coding improvement over time
- **Zero-Configuration**: Works out of the box with intelligent defaults
- **Rich Terminal Output**: Beautiful colors and formatted suggestions

## Installation

### Option 1: Quick Install (Recommended)
```bash
# Install via pip (includes Rust binary)
pip install popat
```

### Option 2: From Source
```bash
# Clone and build from source
git clone https://github.com/An1rud/popat
cd popat
cargo build --release
```

### Option 3: Direct Binary
Download pre-built binaries from [GitHub Releases](https://github.com/An1rud/popat/releases)

## Getting Started

### Step 1: Start Popat Daemon

**For enhanced personality responses:**
```bash
popat start --noise
```

**For standard mode:**
```bash
popat start
```

### Step 2: Code Normally - Popat Monitors Everything

Once started, Popat automatically catches and responds to ANY error:

```python
# Try this Python code with a NameError:
python -c "print(undefined_variable)"
# Popat provides context-aware suggestions and fixes
```

```javascript
# Try this JavaScript code with a TypeError:
node -e "console.log('hello' + undefined.property)"
# Popat analyzes and explains the error with solutions
```

### Step 3: Stop When Done
```bash
popat stop
```

## Complete Command Reference

### Daemon Control
```bash
# Start with enhanced personality
popat start --noise

# Start with standard personality
popat start

# Stop daemon
popat stop

# Check daemon status
popat status
```

### Direct Error Analysis
```bash
# Analyze specific error message
popat analyze "NameError: name 'x' is not defined" --language python

# Analyze error from file
popat analyze --file error.log --language javascript

# Auto-detect language (when possible)
popat analyze "compilation terminated."

# Override personality for single analysis
popat analyze "SyntaxError" --personality sarcastic

# Enable verbose output
popat --verbose analyze "TypeError" --language python
```

### Configuration Management
```bash
# View current configuration
popat config --show

# Set personality
popat config --personality sarcastic

# Configure UI preferences
popat config --emoji true --colors auto

# Enable/disable learning
popat config --learning true

# View version information
popat --version
```

### Shell Integration & Setup
```bash
# Set up shell integration
popat setup --shell bash     # For bash
popat setup --shell zsh      # For zsh  
popat setup --shell fish     # For fish
popat setup --shell powershell # For PowerShell

# Remove shell integration
popat setup --remove
```

### Statistics and Learning
```bash
# View your error statistics
popat stats

# View detailed statistics
popat stats --detailed

# Reset learning data
popat stats --reset
```

### Language-Specific Commands
```bash
# Run Python with automatic error detection
popat python -c "print(undefined_var)"
popat python script.py

# Run Node.js with automatic error detection
popat node -e "console.log(missing_var)"
popat node app.js

# Run Cargo with automatic error detection
popat cargo build
popat cargo test
```

### Diagnostics and Logs
```bash
# Run diagnostic checks
popat doctor

# View recent logs
popat logs --tail 50

# Follow live logs
popat logs --follow

# Show usage examples
popat examples
```

### Interactive and Testing
```bash
# Interactive mode for testing responses
popat interactive

# Test specific error types
popat interactive --error-type NameError

# Test with specific personality
popat interactive --personality sarcastic

# Get help for any command
popat --help
popat analyze --help
popat config --help
```

## Available Response Personalities

Choose the companion that matches your preferred interaction style:

### **Encouraging** - Supportive Assistant
```
Popat: "You're so close! Just need to define 'variable' first!"
Solution: "Check if you meant a different variable name"
Tip: "Use your IDE's autocomplete to avoid typos!"
```

### **Sarcastic** - Direct Expert
```
Popat: "Oh please... 'undefined_variable' doesn't exist and you know it!"
Solution: "Maybe try DEFINING 'undefined_variable' first? Revolutionary idea!"
Note: "Reality check: Variables don't magically appear!"
```

### **Educational** - Patient Teacher
```
Popat: "NameError occurs when Python can't find 'variable' in the current scope."
Solution: "Define 'variable' in the appropriate scope"
Learning: "Python has lexical scoping rules"
```

### **Professional** - Business Consultant  
```
Popat: "NameError: Variable 'x' is not defined in the current scope."
Solution: "Declare variable 'x' before use"
Recommendation: "Use consistent naming conventions"
```

### **Silly** - Comic Relief
```
Popat: "BEEP BOOP! 'variable' has vanished into the digital void!"
Solution: "Summon 'variable' into existence with some code magic!"
Tip: "Variables need to be conjured before use!"
```

## Advanced Usage

### Background Monitoring
Once you run `popat start`, Popat will:
- Monitor all terminal commands automatically
- Detect errors from any programming language
- Provide instant, context-aware suggestions
- Learn from your patterns to improve over time

### Shell Integration
Popat integrates deeply with your shell to catch errors automatically:

```bash
# Bash/Zsh users
popat setup --shell bash
source ~/.bashrc  # or ~/.zshrc

# Fish users  
popat setup --shell fish

# PowerShell users
popat setup --shell powershell
```

### Language Support
Popat automatically detects and supports:
- **Python**: SyntaxError, NameError, IndentationError, ImportError
- **JavaScript/Node.js**: ReferenceError, TypeError, SyntaxError
- **Rust**: Compilation errors, linker errors
- **Java**: Compilation errors, runtime exceptions
- **C/C++**: Compilation errors, linker errors
- **Go**: Compilation errors, runtime panics

## Configuration

Popat stores its configuration in your system's config directory. You can customize:

- Personality type
- Language preferences  
- UI settings (colors, support)
- Privacy settings
- Learning behavior

## How It Works

1. **Background Monitoring**: Popat runs as a lightweight daemon process
2. **Error Interception**: Shell hooks capture command outputs and error codes
3. **Pattern Matching**: Advanced regex and context analysis identify error types
4. **Response Generation**: AI-powered system generates personalized, helpful responses
5. **Learning**: User interactions are analyzed to improve future suggestions

## Troubleshooting

### Common Issues & Solutions

**Q: `popat start --noise` doesn't work**
```bash
# Make sure Popat is properly installed
popat --version

# Run diagnostics to check installation
popat doctor

# Check if daemon is already running
popat status

# Try rebuilding if installed from source
cargo build --release
```

**Q: Not detecting Python errors automatically**
```bash
# Use Popat wrapper commands for immediate detection
popat python -c "print(undefined_var)"

# Or ensure shell integration is set up
popat setup --shell bash  # or your shell

# Test with direct analysis
popat analyze "NameError: test" --language python

# Check diagnostics
popat doctor
```

**Q: Responses are not engaging enough**
```bash
# Make sure you're using the enhanced mode
popat stop
popat start --noise  # This enables enhanced personality!

# Or set sarcastic as default
popat config --personality sarcastic

# Verify current configuration
popat config --show
```

**Q: Shell integration not working**
```bash
# Reload your shell after setup
source ~/.bashrc   # bash
source ~/.zshrc    # zsh
exec fish          # fish

# Or restart your terminal entirely
```

**Q: Permission errors on Windows**
```bash
# Run PowerShell as Administrator for initial setup
# Then use regular terminal for normal operation
```

### Debug Mode
```bash
# Run with verbose output to see what's happening
popat --verbose analyze "test error" --language python

# Run comprehensive diagnostics
popat doctor

# Check daemon logs
popat logs --tail 50

# Follow live logs for real-time debugging
popat logs --follow
```

## Quick Start Summary

**The command that enables intelligent error monitoring:**

```bash
popat start --noise
```

This single command:
- Starts background monitoring
- Enables enhanced personality responses  
- Automatically catches ALL programming errors
- Provides context-aware help with engaging responses
- Learns your patterns to get better over time

**Then just code normally** - Popat handles the rest!

## Contributing

Join our mission to make debugging more efficient! We welcome:

- **Bug Reports**: Found an issue? Let us know!
- **Feature Requests**: Have ideas? We want to hear them!
- **Language Support**: Help add more programming languages  
- **Response Improvements**: Make responses even more helpful
- **Documentation**: Improve guides and examples
- **Testing**: Add test cases for edge cases

### Quick Contribution Guide
```bash
# Fork and clone
git clone https://github.com/An1rud/popat
cd popat

# Make changes
# Add tests
# Update documentation

# Test your changes
cargo test
cargo build --release

# Submit PR with detailed description
```

## License & Legal

**MIT License** - Use Popat freely in personal and commercial projects.

See [LICENSE](LICENSE) for full terms.

## Credits & Acknowledgments

Built with dedication and expertise using:

- **Rust** - For blazing fast performance and memory safety
- **Python** - For easy installation and cross-platform compatibility  
- **SQLite** - For local data storage and learning persistence
- **Crossterm** - For beautiful colored terminal output
- **Clap** - For powerful CLI argument parsing

**Special thanks to:**
- Every developer who's ever stared at a confusing error message
- The Rust community for amazing tools and libraries
- Beta testers who helped make Popat better
- Coffee shops that fuel late-night coding sessions

---

## Ready to Transform Your Debugging Experience?

**Stop struggling with cryptic error messages!**

Install Popat today and get an intelligent coding companion:

```bash
pip install popat
popat start --noise
```

**Your code errors will never be confusing again!**

*Happy debugging! - The Popat Team*

## Complete Command Summary

| Command | Description | Example |
|---------|-------------|----------|
| `popat start` | Start daemon (normal) | `popat start` |
| `popat start --noise` | Start daemon (enhanced) | `popat start --noise` |
| `popat stop` | Stop daemon | `popat stop` |
| `popat status` | Check daemon status | `popat status` |
| `popat analyze` | Analyze error | `popat analyze "NameError"` |
| `popat config` | Manage settings | `popat config --show` |
| `popat python` | Run Python with detection | `popat python script.py` |
| `popat node` | Run Node.js with detection | `popat node app.js` |
| `popat cargo` | Run Cargo with detection | `popat cargo build` |
| `popat setup` | Configure shell integration | `popat setup --shell bash` |
| `popat stats` | View statistics | `popat stats --detailed` |
| `popat interactive` | Interactive testing mode | `popat interactive` |
| `popat logs` | View daemon logs | `popat logs --tail 50` |
| `popat doctor` | Run diagnostics | `popat doctor` |
| `popat examples` | Show usage examples | `popat examples` |
| `popat --version` | Show version info | `popat --version` |
| `popat --verbose` | Enable verbose mode | `popat --verbose analyze` |

## Language Support Matrix

| Language | Error Types Supported | Detection Level | Wrapper Available |
|----------|----------------------|-----------------|-------------------|
| **Python** | 25+ (NameError, TypeError, SyntaxError, IndentationError, ImportError, etc.) | Expert | `py.bat` |
| **JavaScript/Node.js** | TypeError, ReferenceError, SyntaxError, RangeError | Expert | `js.bat` |
| **Rust** | Compilation errors, borrow checker, linker errors | Good | Planned |
| **Java** | CompilationError, RuntimeException, ClassNotFound | Good | Planned |
| **C/C++** | Compilation errors, linker errors, segfaults | Good | Planned |
| **Go** | Compilation errors, runtime panics | Good | Planned |
| **PHP** | Parse errors, fatal errors | Basic | Planned |
| **Ruby** | SyntaxError, NameError, NoMethodError | Basic | Planned |

### Python Error Coverage (25+ Types)
```
NameError           TypeError            ValueError
KeyError            IndexError          AttributeError 
SyntaxError         IndentationError    TabError
ImportError         ModuleNotFoundError FileNotFoundError
PermissionError     RecursionError      ZeroDivisionError
AssertionError      UnboundLocalError   OverflowError
MemoryError         KeyboardInterrupt   SystemExit
StopIteration       GeneratorExit       FloatingPointError
```

## Advanced Features

### Automatic Background Monitoring
Once you run `popat start --noise`, Popat will:
- **Monitor Everything**: All terminal commands across all languages
- **Instant Detection**: Catches errors the moment they happen
- **Context Awareness**: Understands error context and provides relevant suggestions
- **Adaptive Learning**: Gets smarter about your coding patterns over time
- **Zero Interference**: Runs silently without affecting performance

### Deep Shell Integration
Popat integrates seamlessly with your development environment:

```bash
# Bash/Zsh users - One-time setup
popat setup --shell bash
source ~/.bashrc  # Reload shell

# Fish users
popat setup --shell fish

# PowerShell users (Windows)
popat setup --shell powershell
```

After setup, Popat automatically intercepts errors from:
- Direct command execution (`python script.py`)
- Build systems (`make`, `cargo build`, `npm run`)
- Package managers (`pip install`, `npm install`)
- Any command that produces stderr output

## Configuration & Customization

Popat stores configuration in your system's config directory and can be customized via:

```bash
# Set default personality
popat config --personality sarcastic

# Configure UI preferences
popat config --emoji true --colors auto

# Privacy settings
popat config --learning true --telemetry false

# Language preferences
popat config --primary-language python --secondary-language javascript

# View current settings
popat config --show
```

### Configuration Options
- **Personality Types**: encouraging, sarcastic, educational, professional, silly
- **UI Settings**: colors (auto/always/never), emoji support, output format
- **Learning Behavior**: adaptive responses, error pattern tracking, progress monitoring
- **Privacy Controls**: local-only data, telemetry opt-out, anonymous usage stats
- **Language Priorities**: Primary and secondary language detection preferences

## How Popat Works (Under the Hood)

1. **Background Monitoring**: Lightweight daemon process watches terminal activity
2. **Error Interception**: Shell hooks capture command outputs and exit codes  
3. **Pattern Matching**: Advanced regex engine analyzes error messages for type and context
4. **Response Generation**: Personality engine generates contextual, helpful responses
5. **Machine Learning**: User interaction patterns improve future suggestions
6. **Local Storage**: SQLite database stores learning data and user preferences locally

### Architecture Overview
```
Terminal Command → Shell Hook → Error Detection → Pattern Analysis → Response Generation → User Display
                                      ↓
                              SQLite Learning DB ← Feedback Loop ← User Interaction
```

## Performance & Requirements

- **Memory Usage**: ~5-10MB RAM (daemon mode)
- **CPU Impact**: <1% during normal operation
- **Startup Time**: <100ms for daemon initialization
- **Response Time**: <50ms for error analysis and response
- **Storage**: ~1-5MB for learning database
- **Requirements**: 
  - Rust 1.60+ (for building from source)
  - Python 3.7+ (for pip installation)
  - 50MB disk space

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/An1rud/popat",
    "name": "popat",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "error, debugging, humor, terminal, ai, assistant",
    "author": "Anirudh Sajith",
    "author_email": "Popat Team <anirudhsajith03@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/44/d6/605bc2081278280922716e74249353c2003a3345a7990110e91518704ed8/popat-0.1.3.tar.gz",
    "platform": null,
    "description": "# Popat - The Intelligent Terminal Error Helper\r\n\r\n**Advanced error detection and analysis for developers**\r\n\r\nPopat is an intelligent coding assistant that automatically intercepts programming errors and provides helpful, context-aware responses to enhance debugging efficiency and reduce development time.\r\n\r\n## What Makes Popat Special?\r\n\r\nPopat transforms the debugging experience by providing an intelligent assistant that watches your code, catches every error, and responds with personalized guidance. Whether you're a beginner learning to code or an experienced developer working on complex projects, Popat transforms frustrating error messages into clear, actionable insights.\r\n\r\n## Key Features\r\n\r\n- **Automatic Error Detection**: Runs silently in background, catching errors from 25+ programming languages\r\n- **5 Response Personalities**: Choose your debugging companion (Encouraging, Sarcastic, Educational, Professional, Silly)\r\n- **Adaptive Learning**: Gets smarter about your coding patterns and provides personalized assistance\r\n- **Universal Shell Integration**: Works seamlessly with bash, zsh, fish, PowerShell, and cmd\r\n- **Comprehensive Language Support**: Deep error pattern recognition for Python, JavaScript, Rust, Java, C++, Go, and more\r\n- **Progress Tracking**: Monitors error patterns, learning progress, and coding improvement over time\r\n- **Zero-Configuration**: Works out of the box with intelligent defaults\r\n- **Rich Terminal Output**: Beautiful colors and formatted suggestions\r\n\r\n## Installation\r\n\r\n### Option 1: Quick Install (Recommended)\r\n```bash\r\n# Install via pip (includes Rust binary)\r\npip install popat\r\n```\r\n\r\n### Option 2: From Source\r\n```bash\r\n# Clone and build from source\r\ngit clone https://github.com/An1rud/popat\r\ncd popat\r\ncargo build --release\r\n```\r\n\r\n### Option 3: Direct Binary\r\nDownload pre-built binaries from [GitHub Releases](https://github.com/An1rud/popat/releases)\r\n\r\n## Getting Started\r\n\r\n### Step 1: Start Popat Daemon\r\n\r\n**For enhanced personality responses:**\r\n```bash\r\npopat start --noise\r\n```\r\n\r\n**For standard mode:**\r\n```bash\r\npopat start\r\n```\r\n\r\n### Step 2: Code Normally - Popat Monitors Everything\r\n\r\nOnce started, Popat automatically catches and responds to ANY error:\r\n\r\n```python\r\n# Try this Python code with a NameError:\r\npython -c \"print(undefined_variable)\"\r\n# Popat provides context-aware suggestions and fixes\r\n```\r\n\r\n```javascript\r\n# Try this JavaScript code with a TypeError:\r\nnode -e \"console.log('hello' + undefined.property)\"\r\n# Popat analyzes and explains the error with solutions\r\n```\r\n\r\n### Step 3: Stop When Done\r\n```bash\r\npopat stop\r\n```\r\n\r\n## Complete Command Reference\r\n\r\n### Daemon Control\r\n```bash\r\n# Start with enhanced personality\r\npopat start --noise\r\n\r\n# Start with standard personality\r\npopat start\r\n\r\n# Stop daemon\r\npopat stop\r\n\r\n# Check daemon status\r\npopat status\r\n```\r\n\r\n### Direct Error Analysis\r\n```bash\r\n# Analyze specific error message\r\npopat analyze \"NameError: name 'x' is not defined\" --language python\r\n\r\n# Analyze error from file\r\npopat analyze --file error.log --language javascript\r\n\r\n# Auto-detect language (when possible)\r\npopat analyze \"compilation terminated.\"\r\n\r\n# Override personality for single analysis\r\npopat analyze \"SyntaxError\" --personality sarcastic\r\n\r\n# Enable verbose output\r\npopat --verbose analyze \"TypeError\" --language python\r\n```\r\n\r\n### Configuration Management\r\n```bash\r\n# View current configuration\r\npopat config --show\r\n\r\n# Set personality\r\npopat config --personality sarcastic\r\n\r\n# Configure UI preferences\r\npopat config --emoji true --colors auto\r\n\r\n# Enable/disable learning\r\npopat config --learning true\r\n\r\n# View version information\r\npopat --version\r\n```\r\n\r\n### Shell Integration & Setup\r\n```bash\r\n# Set up shell integration\r\npopat setup --shell bash     # For bash\r\npopat setup --shell zsh      # For zsh  \r\npopat setup --shell fish     # For fish\r\npopat setup --shell powershell # For PowerShell\r\n\r\n# Remove shell integration\r\npopat setup --remove\r\n```\r\n\r\n### Statistics and Learning\r\n```bash\r\n# View your error statistics\r\npopat stats\r\n\r\n# View detailed statistics\r\npopat stats --detailed\r\n\r\n# Reset learning data\r\npopat stats --reset\r\n```\r\n\r\n### Language-Specific Commands\r\n```bash\r\n# Run Python with automatic error detection\r\npopat python -c \"print(undefined_var)\"\r\npopat python script.py\r\n\r\n# Run Node.js with automatic error detection\r\npopat node -e \"console.log(missing_var)\"\r\npopat node app.js\r\n\r\n# Run Cargo with automatic error detection\r\npopat cargo build\r\npopat cargo test\r\n```\r\n\r\n### Diagnostics and Logs\r\n```bash\r\n# Run diagnostic checks\r\npopat doctor\r\n\r\n# View recent logs\r\npopat logs --tail 50\r\n\r\n# Follow live logs\r\npopat logs --follow\r\n\r\n# Show usage examples\r\npopat examples\r\n```\r\n\r\n### Interactive and Testing\r\n```bash\r\n# Interactive mode for testing responses\r\npopat interactive\r\n\r\n# Test specific error types\r\npopat interactive --error-type NameError\r\n\r\n# Test with specific personality\r\npopat interactive --personality sarcastic\r\n\r\n# Get help for any command\r\npopat --help\r\npopat analyze --help\r\npopat config --help\r\n```\r\n\r\n## Available Response Personalities\r\n\r\nChoose the companion that matches your preferred interaction style:\r\n\r\n### **Encouraging** - Supportive Assistant\r\n```\r\nPopat: \"You're so close! Just need to define 'variable' first!\"\r\nSolution: \"Check if you meant a different variable name\"\r\nTip: \"Use your IDE's autocomplete to avoid typos!\"\r\n```\r\n\r\n### **Sarcastic** - Direct Expert\r\n```\r\nPopat: \"Oh please... 'undefined_variable' doesn't exist and you know it!\"\r\nSolution: \"Maybe try DEFINING 'undefined_variable' first? Revolutionary idea!\"\r\nNote: \"Reality check: Variables don't magically appear!\"\r\n```\r\n\r\n### **Educational** - Patient Teacher\r\n```\r\nPopat: \"NameError occurs when Python can't find 'variable' in the current scope.\"\r\nSolution: \"Define 'variable' in the appropriate scope\"\r\nLearning: \"Python has lexical scoping rules\"\r\n```\r\n\r\n### **Professional** - Business Consultant  \r\n```\r\nPopat: \"NameError: Variable 'x' is not defined in the current scope.\"\r\nSolution: \"Declare variable 'x' before use\"\r\nRecommendation: \"Use consistent naming conventions\"\r\n```\r\n\r\n### **Silly** - Comic Relief\r\n```\r\nPopat: \"BEEP BOOP! 'variable' has vanished into the digital void!\"\r\nSolution: \"Summon 'variable' into existence with some code magic!\"\r\nTip: \"Variables need to be conjured before use!\"\r\n```\r\n\r\n## Advanced Usage\r\n\r\n### Background Monitoring\r\nOnce you run `popat start`, Popat will:\r\n- Monitor all terminal commands automatically\r\n- Detect errors from any programming language\r\n- Provide instant, context-aware suggestions\r\n- Learn from your patterns to improve over time\r\n\r\n### Shell Integration\r\nPopat integrates deeply with your shell to catch errors automatically:\r\n\r\n```bash\r\n# Bash/Zsh users\r\npopat setup --shell bash\r\nsource ~/.bashrc  # or ~/.zshrc\r\n\r\n# Fish users  \r\npopat setup --shell fish\r\n\r\n# PowerShell users\r\npopat setup --shell powershell\r\n```\r\n\r\n### Language Support\r\nPopat automatically detects and supports:\r\n- **Python**: SyntaxError, NameError, IndentationError, ImportError\r\n- **JavaScript/Node.js**: ReferenceError, TypeError, SyntaxError\r\n- **Rust**: Compilation errors, linker errors\r\n- **Java**: Compilation errors, runtime exceptions\r\n- **C/C++**: Compilation errors, linker errors\r\n- **Go**: Compilation errors, runtime panics\r\n\r\n## Configuration\r\n\r\nPopat stores its configuration in your system's config directory. You can customize:\r\n\r\n- Personality type\r\n- Language preferences  \r\n- UI settings (colors, support)\r\n- Privacy settings\r\n- Learning behavior\r\n\r\n## How It Works\r\n\r\n1. **Background Monitoring**: Popat runs as a lightweight daemon process\r\n2. **Error Interception**: Shell hooks capture command outputs and error codes\r\n3. **Pattern Matching**: Advanced regex and context analysis identify error types\r\n4. **Response Generation**: AI-powered system generates personalized, helpful responses\r\n5. **Learning**: User interactions are analyzed to improve future suggestions\r\n\r\n## Troubleshooting\r\n\r\n### Common Issues & Solutions\r\n\r\n**Q: `popat start --noise` doesn't work**\r\n```bash\r\n# Make sure Popat is properly installed\r\npopat --version\r\n\r\n# Run diagnostics to check installation\r\npopat doctor\r\n\r\n# Check if daemon is already running\r\npopat status\r\n\r\n# Try rebuilding if installed from source\r\ncargo build --release\r\n```\r\n\r\n**Q: Not detecting Python errors automatically**\r\n```bash\r\n# Use Popat wrapper commands for immediate detection\r\npopat python -c \"print(undefined_var)\"\r\n\r\n# Or ensure shell integration is set up\r\npopat setup --shell bash  # or your shell\r\n\r\n# Test with direct analysis\r\npopat analyze \"NameError: test\" --language python\r\n\r\n# Check diagnostics\r\npopat doctor\r\n```\r\n\r\n**Q: Responses are not engaging enough**\r\n```bash\r\n# Make sure you're using the enhanced mode\r\npopat stop\r\npopat start --noise  # This enables enhanced personality!\r\n\r\n# Or set sarcastic as default\r\npopat config --personality sarcastic\r\n\r\n# Verify current configuration\r\npopat config --show\r\n```\r\n\r\n**Q: Shell integration not working**\r\n```bash\r\n# Reload your shell after setup\r\nsource ~/.bashrc   # bash\r\nsource ~/.zshrc    # zsh\r\nexec fish          # fish\r\n\r\n# Or restart your terminal entirely\r\n```\r\n\r\n**Q: Permission errors on Windows**\r\n```bash\r\n# Run PowerShell as Administrator for initial setup\r\n# Then use regular terminal for normal operation\r\n```\r\n\r\n### Debug Mode\r\n```bash\r\n# Run with verbose output to see what's happening\r\npopat --verbose analyze \"test error\" --language python\r\n\r\n# Run comprehensive diagnostics\r\npopat doctor\r\n\r\n# Check daemon logs\r\npopat logs --tail 50\r\n\r\n# Follow live logs for real-time debugging\r\npopat logs --follow\r\n```\r\n\r\n## Quick Start Summary\r\n\r\n**The command that enables intelligent error monitoring:**\r\n\r\n```bash\r\npopat start --noise\r\n```\r\n\r\nThis single command:\r\n- Starts background monitoring\r\n- Enables enhanced personality responses  \r\n- Automatically catches ALL programming errors\r\n- Provides context-aware help with engaging responses\r\n- Learns your patterns to get better over time\r\n\r\n**Then just code normally** - Popat handles the rest!\r\n\r\n## Contributing\r\n\r\nJoin our mission to make debugging more efficient! We welcome:\r\n\r\n- **Bug Reports**: Found an issue? Let us know!\r\n- **Feature Requests**: Have ideas? We want to hear them!\r\n- **Language Support**: Help add more programming languages  \r\n- **Response Improvements**: Make responses even more helpful\r\n- **Documentation**: Improve guides and examples\r\n- **Testing**: Add test cases for edge cases\r\n\r\n### Quick Contribution Guide\r\n```bash\r\n# Fork and clone\r\ngit clone https://github.com/An1rud/popat\r\ncd popat\r\n\r\n# Make changes\r\n# Add tests\r\n# Update documentation\r\n\r\n# Test your changes\r\ncargo test\r\ncargo build --release\r\n\r\n# Submit PR with detailed description\r\n```\r\n\r\n## License & Legal\r\n\r\n**MIT License** - Use Popat freely in personal and commercial projects.\r\n\r\nSee [LICENSE](LICENSE) for full terms.\r\n\r\n## Credits & Acknowledgments\r\n\r\nBuilt with dedication and expertise using:\r\n\r\n- **Rust** - For blazing fast performance and memory safety\r\n- **Python** - For easy installation and cross-platform compatibility  \r\n- **SQLite** - For local data storage and learning persistence\r\n- **Crossterm** - For beautiful colored terminal output\r\n- **Clap** - For powerful CLI argument parsing\r\n\r\n**Special thanks to:**\r\n- Every developer who's ever stared at a confusing error message\r\n- The Rust community for amazing tools and libraries\r\n- Beta testers who helped make Popat better\r\n- Coffee shops that fuel late-night coding sessions\r\n\r\n---\r\n\r\n## Ready to Transform Your Debugging Experience?\r\n\r\n**Stop struggling with cryptic error messages!**\r\n\r\nInstall Popat today and get an intelligent coding companion:\r\n\r\n```bash\r\npip install popat\r\npopat start --noise\r\n```\r\n\r\n**Your code errors will never be confusing again!**\r\n\r\n*Happy debugging! - The Popat Team*\r\n\r\n## Complete Command Summary\r\n\r\n| Command | Description | Example |\r\n|---------|-------------|----------|\r\n| `popat start` | Start daemon (normal) | `popat start` |\r\n| `popat start --noise` | Start daemon (enhanced) | `popat start --noise` |\r\n| `popat stop` | Stop daemon | `popat stop` |\r\n| `popat status` | Check daemon status | `popat status` |\r\n| `popat analyze` | Analyze error | `popat analyze \"NameError\"` |\r\n| `popat config` | Manage settings | `popat config --show` |\r\n| `popat python` | Run Python with detection | `popat python script.py` |\r\n| `popat node` | Run Node.js with detection | `popat node app.js` |\r\n| `popat cargo` | Run Cargo with detection | `popat cargo build` |\r\n| `popat setup` | Configure shell integration | `popat setup --shell bash` |\r\n| `popat stats` | View statistics | `popat stats --detailed` |\r\n| `popat interactive` | Interactive testing mode | `popat interactive` |\r\n| `popat logs` | View daemon logs | `popat logs --tail 50` |\r\n| `popat doctor` | Run diagnostics | `popat doctor` |\r\n| `popat examples` | Show usage examples | `popat examples` |\r\n| `popat --version` | Show version info | `popat --version` |\r\n| `popat --verbose` | Enable verbose mode | `popat --verbose analyze` |\r\n\r\n## Language Support Matrix\r\n\r\n| Language | Error Types Supported | Detection Level | Wrapper Available |\r\n|----------|----------------------|-----------------|-------------------|\r\n| **Python** | 25+ (NameError, TypeError, SyntaxError, IndentationError, ImportError, etc.) | Expert | `py.bat` |\r\n| **JavaScript/Node.js** | TypeError, ReferenceError, SyntaxError, RangeError | Expert | `js.bat` |\r\n| **Rust** | Compilation errors, borrow checker, linker errors | Good | Planned |\r\n| **Java** | CompilationError, RuntimeException, ClassNotFound | Good | Planned |\r\n| **C/C++** | Compilation errors, linker errors, segfaults | Good | Planned |\r\n| **Go** | Compilation errors, runtime panics | Good | Planned |\r\n| **PHP** | Parse errors, fatal errors | Basic | Planned |\r\n| **Ruby** | SyntaxError, NameError, NoMethodError | Basic | Planned |\r\n\r\n### Python Error Coverage (25+ Types)\r\n```\r\nNameError           TypeError            ValueError\r\nKeyError            IndexError          AttributeError \r\nSyntaxError         IndentationError    TabError\r\nImportError         ModuleNotFoundError FileNotFoundError\r\nPermissionError     RecursionError      ZeroDivisionError\r\nAssertionError      UnboundLocalError   OverflowError\r\nMemoryError         KeyboardInterrupt   SystemExit\r\nStopIteration       GeneratorExit       FloatingPointError\r\n```\r\n\r\n## Advanced Features\r\n\r\n### Automatic Background Monitoring\r\nOnce you run `popat start --noise`, Popat will:\r\n- **Monitor Everything**: All terminal commands across all languages\r\n- **Instant Detection**: Catches errors the moment they happen\r\n- **Context Awareness**: Understands error context and provides relevant suggestions\r\n- **Adaptive Learning**: Gets smarter about your coding patterns over time\r\n- **Zero Interference**: Runs silently without affecting performance\r\n\r\n### Deep Shell Integration\r\nPopat integrates seamlessly with your development environment:\r\n\r\n```bash\r\n# Bash/Zsh users - One-time setup\r\npopat setup --shell bash\r\nsource ~/.bashrc  # Reload shell\r\n\r\n# Fish users\r\npopat setup --shell fish\r\n\r\n# PowerShell users (Windows)\r\npopat setup --shell powershell\r\n```\r\n\r\nAfter setup, Popat automatically intercepts errors from:\r\n- Direct command execution (`python script.py`)\r\n- Build systems (`make`, `cargo build`, `npm run`)\r\n- Package managers (`pip install`, `npm install`)\r\n- Any command that produces stderr output\r\n\r\n## Configuration & Customization\r\n\r\nPopat stores configuration in your system's config directory and can be customized via:\r\n\r\n```bash\r\n# Set default personality\r\npopat config --personality sarcastic\r\n\r\n# Configure UI preferences\r\npopat config --emoji true --colors auto\r\n\r\n# Privacy settings\r\npopat config --learning true --telemetry false\r\n\r\n# Language preferences\r\npopat config --primary-language python --secondary-language javascript\r\n\r\n# View current settings\r\npopat config --show\r\n```\r\n\r\n### Configuration Options\r\n- **Personality Types**: encouraging, sarcastic, educational, professional, silly\r\n- **UI Settings**: colors (auto/always/never), emoji support, output format\r\n- **Learning Behavior**: adaptive responses, error pattern tracking, progress monitoring\r\n- **Privacy Controls**: local-only data, telemetry opt-out, anonymous usage stats\r\n- **Language Priorities**: Primary and secondary language detection preferences\r\n\r\n## How Popat Works (Under the Hood)\r\n\r\n1. **Background Monitoring**: Lightweight daemon process watches terminal activity\r\n2. **Error Interception**: Shell hooks capture command outputs and exit codes  \r\n3. **Pattern Matching**: Advanced regex engine analyzes error messages for type and context\r\n4. **Response Generation**: Personality engine generates contextual, helpful responses\r\n5. **Machine Learning**: User interaction patterns improve future suggestions\r\n6. **Local Storage**: SQLite database stores learning data and user preferences locally\r\n\r\n### Architecture Overview\r\n```\r\nTerminal Command \u2192 Shell Hook \u2192 Error Detection \u2192 Pattern Analysis \u2192 Response Generation \u2192 User Display\r\n                                      \u2193\r\n                              SQLite Learning DB \u2190 Feedback Loop \u2190 User Interaction\r\n```\r\n\r\n## Performance & Requirements\r\n\r\n- **Memory Usage**: ~5-10MB RAM (daemon mode)\r\n- **CPU Impact**: <1% during normal operation\r\n- **Startup Time**: <100ms for daemon initialization\r\n- **Response Time**: <50ms for error analysis and response\r\n- **Storage**: ~1-5MB for learning database\r\n- **Requirements**: \r\n  - Rust 1.60+ (for building from source)\r\n  - Python 3.7+ (for pip installation)\r\n  - 50MB disk space\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Intelligent Terminal Error Helper - Advanced error detection and analysis for developers",
    "version": "0.1.3",
    "project_urls": {
        "Bug Reports": "https://github.com/An1rud/popat/issues",
        "Documentation": "https://github.com/An1rud/popat#readme",
        "Download": "https://pypi.org/project/popat/",
        "Homepage": "https://github.com/An1rud/popat",
        "Repository": "https://github.com/An1rud/popat",
        "Source Code": "https://github.com/An1rud/popat"
    },
    "split_keywords": [
        "error",
        " debugging",
        " humor",
        " terminal",
        " ai",
        " assistant"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "44d6605bc2081278280922716e74249353c2003a3345a7990110e91518704ed8",
                "md5": "d55809f9b2fa1d85ccc113e196fd8c43",
                "sha256": "9dbfdab7827634fd935ee7011770bfab52621c43eb47862db1c411e7b94f836a"
            },
            "downloads": -1,
            "filename": "popat-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "d55809f9b2fa1d85ccc113e196fd8c43",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2131656,
            "upload_time": "2025-09-07T07:03:50",
            "upload_time_iso_8601": "2025-09-07T07:03:50.024335Z",
            "url": "https://files.pythonhosted.org/packages/44/d6/605bc2081278280922716e74249353c2003a3345a7990110e91518704ed8/popat-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-07 07:03:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "An1rud",
    "github_project": "popat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "popat"
}