Metadata-Version: 2.4
Name: web-alert
Version: 1.0.0
Summary: Modern web monitoring and alert system with customizable GUI for tracking website changes
Project-URL: Homepage, https://github.com/Almas-Ali/web-alert
Project-URL: Repository, https://github.com/Almas-Ali/web-alert
Project-URL: Issues, https://github.com/Almas-Ali/web-alert/issues
Project-URL: Documentation, https://github.com/Almas-Ali/web-alert#readme
Author-email: "Md. Almas Ali" <almaspr3@gmail.com>
Maintainer-email: "Md. Almas Ali" <almaspr3@gmail.com>
License: MIT
License-File: LICENSE
Keywords: alert-system,change-detection,customtkinter,gui,web-monitoring,web-scraper,website-tracker
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: customtkinter>=5.2.0
Requires-Dist: lxml>=4.9.0
Requires-Dist: requests>=2.31.0
Requires-Dist: sqlalchemy>=2.0.0
Description-Content-Type: text/markdown

# Web Alert 🔔

A beautiful, easy-to-use desktop application that watches websites for you and plays a sound when something changes. Perfect for tracking price drops, news updates, stock availability, or any website content you care about!

## ✨ Key Features

### 🎯 Easy to Use
- **Beautiful Dashboard** - Clean, modern interface that anyone can use
- **Multiple Monitors** - Watch as many websites as you want at the same time
- **One-Click Control** - Start, stop, or remove monitors with a single click
- **Remembers Everything** - Your monitors stay saved even after you close the app

### 🔍 Smart Monitoring
- **Whole Page or Specific Parts** - Watch entire pages or just the parts you care about
- **Three Detection Modes** - Choose how to detect changes (simple text, full page, or fast)
- **Custom Schedules** - Set how often each website should be checked (every minute, hour, etc.)
- **Real-Time Status** - See exactly what's happening with each monitor

### 🎨 Personalization
- **Light & Dark Themes** - Choose the look that suits you best
- **Custom Alert Sounds** - Use the built-in sound or upload your own
- **Your Settings Saved** - Theme and preferences saved automatically
- **Configuration History** - Quickly reuse previous monitoring setups

### 📊 Activity Tracking
- **Individual Logs** - Each monitor has its own activity history
- **Export Logs** - Save logs to review later
- **Add Notes** - Keep track of why you're monitoring each site
- **Statistics** - See how many changes detected and alerts played

## 📥 Installation

### Super Easy Installation (Recommended)

**Just one command!** Open a terminal/command prompt and type:

```bash
pip install web-alert
```

That's it! The app and all its requirements install automatically. ✨

### First Time Using Python?

If you don't have Python yet:

1. **Install Python**:
   - Visit [python.org](https://www.python.org/downloads/)
   - Download Python 3.10 or newer
   - ⚠️ **Important**: During installation, check "Add Python to PATH"

2. **Install Web Alert**:
   ```bash
   pip install web-alert
   ```

### For Developers

Want to modify the code? Clone the repository:

```bash
git clone https://github.com/Almas-Ali/web-alert.git
cd web-alert

# Using uv (recommended)
uv sync
uv run main.py

# Or with pip
pip install -e .
python main.py
```

## 🚀 Getting Started

### Starting the Application

After installation, simply run:

```bash
web-alert
```

The dashboard will open with a beautiful purple header and a clean interface.

**That's it!** No need to navigate to any folder or run Python directly. The `web-alert` command works from anywhere! 🎉

### Your First Monitor in 3 Steps

#### Step 1: Add a Website to Monitor
1. Click the **"+ Add"** button in the top right
2. A window opens - enter the website URL (e.g., `https://example.com/product`)
3. Leave other settings as default for now
4. Click **"Add Job"**

#### Step 2: Start Monitoring
- Click the green **"▶ Start"** button next to your website
- The status will change to "Running" (in green)
- You'll see when it was last checked

#### Step 3: Get Alerted
- When the website changes, you'll hear an alert sound
- Check the "Logs" to see what changed and when

That's it! 🎉

### Understanding the Dashboard

**Top Buttons:**
- **▶ Start** - Start monitoring all websites at once
- **⏸ Stop** - Stop all monitoring
- **+ Add** - Add a new website to monitor

**For Each Website:**
- **Green "Start" button** - Begin checking this website
- **Red "Stop" button** - Pause checking (appears when running)
- **Blue "Logs" button** - View activity history and add notes
- **Gray "Remove" button** - Delete this monitor

**Menu Bar:**
- **File** → Quick access to add/start/stop operations
- **View** → Change between Light, Dark, or System theme
- **History** → See and reuse previous monitoring setups

### Using History (Save Time!)

Previously monitored something? Load it again instantly:

1. **While Adding**: Click "📜 Load from History" button
2. **From Menu**: Go to History → View All History
3. **Click "Add as Job"** - All settings restored automatically!

Every website you monitor is saved automatically. No need to remember settings!

## ⚙️ Configuration Options (Optional)

These are **optional** - the defaults work great! But if you want more control:

### Detection Modes

Choose how to detect changes (default is "text" - recommended for most users):

- **Text Mode** ⭐ (Recommended)
  - Watches the actual words on the page
  - Ignores design changes, ads, and timestamps
  - Perfect for: prices, availability, news articles

- **HTML Mode**
  - Watches everything including page structure
  - Detects even tiny changes
  - Perfect for: complete page monitoring

- **Hash Mode**
  - Super fast checking
  - Detects any change at all
  - Perfect for: frequent checks, simple pages

### Check Interval

How often to check the website:
- **Quick checks**: 5-10 seconds (careful - don't overload websites!)
- **Normal**: 60 seconds (1 minute) - good default
- **Relaxed**: 300 seconds (5 minutes) or more

**Tip**: Start with 60 seconds and adjust based on how often the site changes.

### CSS Selectors (Advanced)

Want to watch just part of a page? Use CSS selectors:
- **Leave empty** - Watch the whole page (easiest!)
- **`#price`** - Watch the price element
- **`.stock-status`** - Watch stock availability
- **`h1.title`** - Watch the page title

**Don't know CSS?** No problem! Just leave it empty to watch everything.

### Custom Alert Sounds

Don't like the default beep?
1. Click "Browse" next to Alert Sound
2. Pick your own WAV sound file
3. Or leave default for the built-in alert

## 🎨 Themes

Change the app's appearance to match your preference:

1. Click **View** in the menu bar
2. Choose **Theme**:
   - **☀️ Light** - Bright, clean look
   - **🌙 Dark** - Easy on the eyes
   - **💻 System** - Matches your computer's theme

Your choice is saved automatically!

## 📂 Where Things Are Saved

All your data is stored locally on your computer:

- **Monitoring settings**: Saved in `web_alert_store.db`
- **Activity logs**: Saved with each monitor
- **Theme preference**: Remembered automatically
- **Alert sound**: Stored in `sounds/` folder

**Nothing is sent to the internet** - everything stays on your computer!

## 💡 What Can I Use This For?

Here are some real-world examples:

### Shopping & Deals
- 🛒 **Track product availability**: Know the moment that sold-out item is back in stock
- 💰 **Watch prices**: Get notified when your favorite product goes on sale
- 🎁 **Monitor deals**: Catch limited-time offers before they expire

### Career & Education
- 💼 **Job postings**: Be the first to apply when a new position opens
- 📚 **University admissions**: Know when results or announcements are posted
- 🏫 **Course registration**: Get alerts when spots open up

### News & Information
- 📰 **Breaking news**: Track updates on topics you care about
- 🏛️ **Government updates**: Monitor official documents or announcements
- 🏆 **Sports scores**: Track game results or league standings

### Personal Projects
- 🎮 **Game servers**: Check if your favorite server is online
- 📱 **App updates**: Know when a new version is released
- 🌐 **Website changes**: Track updates to any webpage you're interested in

**The possibilities are endless!** If it's on the web, you can monitor it.
- Total changes detected
- Total alerts played
- Active URL being monitored

## Use Cases

- **Price Monitoring**: Track price changes on e-commerce sites
- **News Updates**: Get alerted when news sites publish new articles
- **Product Availability**: Monitor "Out of Stock" to "In Stock" changes
- **Content Updates**: Track blog posts or website content changes
- **API Status Pages**: Monitor service status dashboards
- **Competition Tracking**: Watch competitor website updates

## 💭 Helpful Tips

### For Best Results:
1. ⏱️ **Start with 60 seconds** - Don't check too often or websites might block you
2. 🎯 **Watch specific parts** - Use CSS selectors to avoid false alarms from ads
3. 🔊 **Test your alert** - Click "Test Sound" before you start monitoring
4. 💾 **Use History** - Save configs for websites you check often
5. 📝 **Use Text mode** - Ignores changing ads and timestamps

### Being a Good Internet Citizen:
- Don't set intervals too short (under 30 seconds)
- Respect websites by not overloading them
- Some websites might block frequent checks

## 📋 System Requirements

To run this app, you need:
- **Operating System**: Windows (7, 10, or 11)
- **Python**: Version 3.8 or newer
- **Internet**: Active connection to check websites
- **Sound**: Speakers or headphones for alerts

## 🆘 Common Issues & Solutions

### "I'm not hearing any alerts!"
**Solutions:**
- ✅ Make sure your computer sound is turned on
- ✅ Click the "Test Sound" button to check if it works
- ✅ Try using the default alert (leave sound path empty)
- ✅ Check if your speakers/headphones are connected

### "It keeps alerting but nothing changed!"
**Solutions:**
- ✅ Switch to **Text Mode** (ignores ads and animations)
- ✅ Use a CSS selector to watch just the part you care about
- ✅ Some websites have timestamps that change constantly

### "It's not detecting any changes!"
**Solutions:**
- ✅ Check if the website opens in your web browser
- ✅ Try increasing the check interval (60 seconds)
- ✅ Make sure your CSS selector is correct (or leave it empty)
- ✅ Try switching to **HTML Mode** for more sensitive detection

### "The app won't start!"
**Solutions:**
- ✅ Make sure Python is installed correctly
- ✅ Run `uv sync` again to install dependencies
- ✅ Check if your antivirus is blocking it

### "I get an error about Python not found"
**Solutions:**
- ✅ Reinstall Python from python.org
- ✅ During installation, check "Add Python to PATH"
- ✅ Restart your computer after installing

### Still Having Problems?
Open an issue on GitHub with:
- What you were trying to do
- The exact error message
- Screenshots if possible

## 🤝 Want to Help Improve This App?

Found a bug? Have an idea for a new feature? Contributions are welcome!

- **Report bugs**: Open an issue on GitHub
- **Suggest features**: Tell us what you'd like to see
- **Improve code**: Submit a pull request
- **Share feedback**: Let us know how you're using it!

## 📄 License

MIT License - Free to use, modify, and share!

## ⚠️ Important Reminder

**Be Respectful:**
- Don't check websites too frequently (use 30+ second intervals)
- Respect website terms of service
- Excessive requests may get you blocked
- Use this tool responsibly!

---

## 👨‍💻 About

Created with ❤️ for anyone who needs to track website changes without constantly refreshing their browser.

**Made possible by**: Python, CustomTkinter, and coffee ☕

---

### Ready to Start?
1. Install: `pip install web-alert`
2. Run: `web-alert`
3. Add your first monitor
4. Sit back and let it watch for you! 🎉

---

**Installation troubleshooting?** Check the [Common Issues](#-common-issues--solutions) section above.
