logwatchdog


Namelogwatchdog JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/pandiyarajk/logwatchdog
SummaryComprehensive Windows log monitoring and management solution
upload_time2025-08-23 06:24:18
maintainerNone
docs_urlNone
authorPandiyaraj Karuppasamy
requires_python>=3.7
licenseMIT
keywords log monitoring windows notifications alerts system-administration security auditing real-time watchdog monitoring-tool log-analysis event-logging system-monitoring
VCS
bugtrack_url
requirements plyer python-dotenv psutil watchdog email-validator
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LogWatchdog

[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://img.shields.io/pypi/v/logwatchdog.svg)](https://pypi.org/project/logwatchdog/)
[![GitHub](https://img.shields.io/badge/github-logwatchdog-green.svg)](https://github.com/pandiyarajk/logwatchdog)
[![Build Log Watchdog Executable](https://github.com/Pandiyarajk/logwatchdog/actions/workflows/build-exe.yml/badge.svg)](https://github.com/Pandiyarajk/logwatchdog/actions/workflows/build-exe.yml)

**LogWatchdog** is a production-ready Windows log monitoring solution that provides real-time monitoring, notifications, and automated log management capabilities.

## 🚀 Features

- **Real-time Log Monitoring**: Monitor single files, multiple files, or entire folders
- **Smart Notifications**: Email alerts and system tray notifications for critical events
- **Configurable Alerts**: Customizable exception keywords and notification rules
- **File Discovery**: Automatic detection of new log files
- **Windows Native**: Designed specifically for Windows 10/11 systems

## 📋 Requirements

- **Python 3.7+**
- **Windows 10/11** (primary target)

## 🛠️ Installation

### From PyPI (Recommended)

```bash
pip install logwatchdog
```

### From Source

```bash
git clone https://github.com/pandiyarajk/logwatchdog.git
cd logwatchdog
pip install -r requirements.txt
```

## 🚀 Quick Start

### 1. Configuration Files

Create `log_config.ini` for monitoring settings:

```ini
[monitoring]
monitor_mode = folder                    # single, multiple, or folder
log_folder_path = C:\logs               # Folder to monitor
log_file_extensions = *.log,*.txt       # File extensions to monitor
file_discovery_interval = 30            # Check for new files every 30 seconds
empty_monitor_delay = 10                # Delay when no files found

[notifications]
email_enabled = true
smtp_server = smtp.gmail.com
smtp_port = 587
receiver_group = admin@company.com
system_tray_notifications = true

[alerts]
exception_keywords = Exception,Error,Failure,Fail,Fatal,Issue,Crash
```

### 2. Email Credentials

Create `.env` file for email authentication:

```bash
# Copy env_example.txt to .env and fill in your credentials
EMAIL_USER=your-email@gmail.com
EMAIL_PASSWORD=your-app-password
```

**Security Note**: Never commit the `.env` file to version control.

### 3. Start Monitoring

```bash
# Start monitoring with default settings
logwatchdog

# Or use the short command
lwd
```

## 📁 Monitoring Modes

- **Single File**: Monitor one specific log file
- **Multiple Files**: Monitor multiple specific log files simultaneously  
- **Folder**: Monitor all log files in a folder with automatic file detection

## 🔧 Configuration

### Main Settings (`log_config.ini`)

- Monitoring mode and file paths
- SMTP server configuration
- Alert keywords and notification settings
- File discovery intervals

### Email Credentials (`.env`)

- `EMAIL_USER`: Your email address
- `EMAIL_PASSWORD`: Your email password or app password

## 📚 Documentation

- **User Guide**: See the code comments and configuration examples
- **Issues**: [GitHub Issues](https://github.com/pandiyarajk/logwatchdog/issues)
- **Support**: pandiyarajk@live.com

## 🤝 Contributing

We welcome contributions! Please see [CONTRIBUTING.md](https://github.com/pandiyarajk/logwatchdog/blob/main/CONTRIBUTING.md) for details.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/pandiyarajk/logwatchdog/blob/main/LICENSE) file for details.

## 🔄 Changelog

See [CHANGELOG.md](https://github.com/pandiyarajk/logwatchdog/blob/main/CHANGELOG.md) for version history.

---

**Made with ❤️ by [Pandiyaraj Karuppasamy](https://github.com/pandiyarajk)**

*LogWatchdog - Your Windows Log Monitoring Companion*

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pandiyarajk/logwatchdog",
    "name": "logwatchdog",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "log, monitoring, windows, notifications, alerts, system-administration, security, auditing, real-time, watchdog, monitoring-tool, log-analysis, event-logging, system-monitoring",
    "author": "Pandiyaraj Karuppasamy",
    "author_email": "pandiyarajk@live.com",
    "download_url": "https://files.pythonhosted.org/packages/1b/ae/c5c07b7faab7705d9d050807593e5e1b0e80d51a0238f9f03785c424a0f7/logwatchdog-1.0.1.tar.gz",
    "platform": "win32",
    "description": "# LogWatchdog\r\n\r\n[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n[![PyPI version](https://img.shields.io/pypi/v/logwatchdog.svg)](https://pypi.org/project/logwatchdog/)\r\n[![GitHub](https://img.shields.io/badge/github-logwatchdog-green.svg)](https://github.com/pandiyarajk/logwatchdog)\r\n[![Build Log Watchdog Executable](https://github.com/Pandiyarajk/logwatchdog/actions/workflows/build-exe.yml/badge.svg)](https://github.com/Pandiyarajk/logwatchdog/actions/workflows/build-exe.yml)\r\n\r\n**LogWatchdog** is a production-ready Windows log monitoring solution that provides real-time monitoring, notifications, and automated log management capabilities.\r\n\r\n## \ud83d\ude80 Features\r\n\r\n- **Real-time Log Monitoring**: Monitor single files, multiple files, or entire folders\r\n- **Smart Notifications**: Email alerts and system tray notifications for critical events\r\n- **Configurable Alerts**: Customizable exception keywords and notification rules\r\n- **File Discovery**: Automatic detection of new log files\r\n- **Windows Native**: Designed specifically for Windows 10/11 systems\r\n\r\n## \ud83d\udccb Requirements\r\n\r\n- **Python 3.7+**\r\n- **Windows 10/11** (primary target)\r\n\r\n## \ud83d\udee0\ufe0f Installation\r\n\r\n### From PyPI (Recommended)\r\n\r\n```bash\r\npip install logwatchdog\r\n```\r\n\r\n### From Source\r\n\r\n```bash\r\ngit clone https://github.com/pandiyarajk/logwatchdog.git\r\ncd logwatchdog\r\npip install -r requirements.txt\r\n```\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### 1. Configuration Files\r\n\r\nCreate `log_config.ini` for monitoring settings:\r\n\r\n```ini\r\n[monitoring]\r\nmonitor_mode = folder                    # single, multiple, or folder\r\nlog_folder_path = C:\\logs               # Folder to monitor\r\nlog_file_extensions = *.log,*.txt       # File extensions to monitor\r\nfile_discovery_interval = 30            # Check for new files every 30 seconds\r\nempty_monitor_delay = 10                # Delay when no files found\r\n\r\n[notifications]\r\nemail_enabled = true\r\nsmtp_server = smtp.gmail.com\r\nsmtp_port = 587\r\nreceiver_group = admin@company.com\r\nsystem_tray_notifications = true\r\n\r\n[alerts]\r\nexception_keywords = Exception,Error,Failure,Fail,Fatal,Issue,Crash\r\n```\r\n\r\n### 2. Email Credentials\r\n\r\nCreate `.env` file for email authentication:\r\n\r\n```bash\r\n# Copy env_example.txt to .env and fill in your credentials\r\nEMAIL_USER=your-email@gmail.com\r\nEMAIL_PASSWORD=your-app-password\r\n```\r\n\r\n**Security Note**: Never commit the `.env` file to version control.\r\n\r\n### 3. Start Monitoring\r\n\r\n```bash\r\n# Start monitoring with default settings\r\nlogwatchdog\r\n\r\n# Or use the short command\r\nlwd\r\n```\r\n\r\n## \ud83d\udcc1 Monitoring Modes\r\n\r\n- **Single File**: Monitor one specific log file\r\n- **Multiple Files**: Monitor multiple specific log files simultaneously  \r\n- **Folder**: Monitor all log files in a folder with automatic file detection\r\n\r\n## \ud83d\udd27 Configuration\r\n\r\n### Main Settings (`log_config.ini`)\r\n\r\n- Monitoring mode and file paths\r\n- SMTP server configuration\r\n- Alert keywords and notification settings\r\n- File discovery intervals\r\n\r\n### Email Credentials (`.env`)\r\n\r\n- `EMAIL_USER`: Your email address\r\n- `EMAIL_PASSWORD`: Your email password or app password\r\n\r\n## \ud83d\udcda Documentation\r\n\r\n- **User Guide**: See the code comments and configuration examples\r\n- **Issues**: [GitHub Issues](https://github.com/pandiyarajk/logwatchdog/issues)\r\n- **Support**: pandiyarajk@live.com\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see [CONTRIBUTING.md](https://github.com/pandiyarajk/logwatchdog/blob/main/CONTRIBUTING.md) for details.\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/pandiyarajk/logwatchdog/blob/main/LICENSE) file for details.\r\n\r\n## \ud83d\udd04 Changelog\r\n\r\nSee [CHANGELOG.md](https://github.com/pandiyarajk/logwatchdog/blob/main/CHANGELOG.md) for version history.\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by [Pandiyaraj Karuppasamy](https://github.com/pandiyarajk)**\r\n\r\n*LogWatchdog - Your Windows Log Monitoring Companion*\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Comprehensive Windows log monitoring and management solution",
    "version": "1.0.1",
    "project_urls": {
        "Bug Reports": "https://github.com/pandiyarajk/logwatchdog/issues",
        "Changelog": "https://github.com/pandiyarajk/logwatchdog/blob/main/CHANGELOG.md",
        "Documentation": "https://github.com/pandiyarajk/logwatchdog/blob/main/README.md",
        "Download": "https://github.com/pandiyarajk/logwatchdog/releases",
        "Homepage": "https://github.com/pandiyarajk/logwatchdog",
        "Source": "https://github.com/pandiyarajk/logwatchdog"
    },
    "split_keywords": [
        "log",
        " monitoring",
        " windows",
        " notifications",
        " alerts",
        " system-administration",
        " security",
        " auditing",
        " real-time",
        " watchdog",
        " monitoring-tool",
        " log-analysis",
        " event-logging",
        " system-monitoring"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4491ebb5e5e0d177fd9c928e0eb066eeb000eb17bc8944ab674ce630b00f2adf",
                "md5": "333f214c2217fb0a5214133a44f38650",
                "sha256": "cd6b5cacfb687d2d6aaf43b649eea10093cdc7b38b0b99dd620cb5ba95128559"
            },
            "downloads": -1,
            "filename": "logwatchdog-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "333f214c2217fb0a5214133a44f38650",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 16381,
            "upload_time": "2025-08-23T06:24:17",
            "upload_time_iso_8601": "2025-08-23T06:24:17.776352Z",
            "url": "https://files.pythonhosted.org/packages/44/91/ebb5e5e0d177fd9c928e0eb066eeb000eb17bc8944ab674ce630b00f2adf/logwatchdog-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1baec5c07b7faab7705d9d050807593e5e1b0e80d51a0238f9f03785c424a0f7",
                "md5": "d6e17da7c9d3bc5a8f14d2ed9f8d7420",
                "sha256": "f0515cfaac64201d8feb8ef587ae3ca5eae8f9085d9ee540079f3e5e6e9ab974"
            },
            "downloads": -1,
            "filename": "logwatchdog-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d6e17da7c9d3bc5a8f14d2ed9f8d7420",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 16485,
            "upload_time": "2025-08-23T06:24:18",
            "upload_time_iso_8601": "2025-08-23T06:24:18.996474Z",
            "url": "https://files.pythonhosted.org/packages/1b/ae/c5c07b7faab7705d9d050807593e5e1b0e80d51a0238f9f03785c424a0f7/logwatchdog-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-23 06:24:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pandiyarajk",
    "github_project": "logwatchdog",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "plyer",
            "specs": [
                [
                    ">=",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "python-dotenv",
            "specs": [
                [
                    ">=",
                    "0.19.0"
                ]
            ]
        },
        {
            "name": "psutil",
            "specs": [
                [
                    ">=",
                    "5.8.0"
                ]
            ]
        },
        {
            "name": "watchdog",
            "specs": [
                [
                    ">=",
                    "2.1.0"
                ]
            ]
        },
        {
            "name": "email-validator",
            "specs": [
                [
                    ">=",
                    "1.1.3"
                ]
            ]
        }
    ],
    "lcname": "logwatchdog"
}
        
Elapsed time: 0.74059s