feat: Add release preparation script and fix merge conflicts

APMarzuki · APMarzuki · commit 6d702d6294b1 · 2025-11-20T09:24:34.000+01:00
- Add quick_release.py for GitHub releases
- Resolve LICENSE merge conflict
- Prepare v1.0.0 release files
diff --git a/LICENSE b/LICENSE
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/quick_release.py b/quick_release.py
@@ -0,0 +1,72 @@
+# quick_release_fixed.py
+import os
+import shutil
+import datetime
+
+
+def prepare_release():
+    print("Preparing CyberGuardian-X v1.0.0 Release...")
+
+    # Create release directory
+    release_dir = "release_v1.0.0"
+    if os.path.exists(release_dir):
+        shutil.rmtree(release_dir)
+    os.makedirs(release_dir)
+
+    # Copy executable
+    exe_source = "dist/CyberGuardian-X.exe"
+    if os.path.exists(exe_source):
+        shutil.copy2(exe_source, release_dir)
+        print("Copied: CyberGuardian-X.exe")
+    else:
+        print("Executable not found. Build it first.")
+        return
+
+    # Copy key documentation
+    files_to_copy = [
+        "README.md",
+        "LICENSE",
+        "requirements.txt",
+        "keys.example.ini"
+    ]
+
+    for file in files_to_copy:
+        if os.path.exists(file):
+            shutil.copy2(file, release_dir)
+            print(f"Copied: {file}")
+
+    # Create quick start guide WITHOUT emojis
+    with open(f"{release_dir}/QUICK_START.md", "w", encoding='utf-8') as f:
+        f.write("""# CyberGuardian-X Quick Start
+
+## 1. Run the Application
+Double-click `CyberGuardian-X.exe`
+
+## 2. Configure API Keys
+1. Copy `keys.example.ini` to `config.ini`
+2. Add your API keys to `config.ini`
+3. Get free API keys from:
+   - VirusTotal: https://www.virustotal.com/gui/join-us
+   - AbuseIPDB: https://www.abuseipdb.com/account/api
+   - OTX: https://otx.alienvault.com/api
+   - Shodan: https://account.shodan.io/
+   - URLScan: https://urlscan.io/about-api/
+   - Hybrid Analysis: https://www.hybrid-analysis.com/signup
+   - MetaDefender: https://www.metadefender.com/signup
+
+## 3. Start Scanning!
+- Use the GUI for interactive scanning
+- Enable real-time monitoring in Settings
+- Scan domains, IPs, and files for threats
+
+## Support
+- Issues: https://github.com/APMarzuki/CyberGuardian-X/issues
+- Discussions: https://github.com/APMarzuki/CyberGuardian-X/discussions
+""")
+
+    print(f"Release package ready in: {release_dir}/")
+    print("Upload the entire folder to GitHub Releases!")
+
+
+if __name__ == "__main__":
+    prepare_release()
diff --git a/release_v1.0.0/CyberGuardian-X.exe b/release_v1.0.0/CyberGuardian-X.exe
diff --git a/release_v1.0.0/LICENSE b/release_v1.0.0/LICENSE
@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2025 APMarzuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+<<<<<<< HEAD
+SOFTWARE.
+=======
+SOFTWARE.
+>>>>>>> 81109202452a45f4ee8fc386c5c7de167cd77db4
diff --git a/release_v1.0.0/QUICK_START.md b/release_v1.0.0/QUICK_START.md
@@ -0,0 +1,25 @@
+# CyberGuardian-X Quick Start
+
+## 1. Run the Application
+Double-click `CyberGuardian-X.exe`
+
+## 2. Configure API Keys
+1. Copy `keys.example.ini` to `config.ini`
+2. Add your API keys to `config.ini`
+3. Get free API keys from:
+   - VirusTotal: https://www.virustotal.com/gui/join-us
+   - AbuseIPDB: https://www.abuseipdb.com/account/api
+   - OTX: https://otx.alienvault.com/api
+   - Shodan: https://account.shodan.io/
+   - URLScan: https://urlscan.io/about-api/
+   - Hybrid Analysis: https://www.hybrid-analysis.com/signup
+   - MetaDefender: https://www.metadefender.com/signup
+
+## 3. Start Scanning!
+- Use the GUI for interactive scanning
+- Enable real-time monitoring in Settings
+- Scan domains, IPs, and files for threats
+
+## Support
+- Issues: https://github.com/APMarzuki/CyberGuardian-X/issues
+- Discussions: https://github.com/APMarzuki/CyberGuardian-X/discussions
diff --git a/release_v1.0.0/README.md b/release_v1.0.0/README.md
@@ -0,0 +1,227 @@
+# 🛡️ CyberGuardian-X - Unified Security & Threat Intelligence Suite
+
+![CyberGuardian-X](assets/logo.png)
+
+**Professional-grade cybersecurity tool that combines threat intelligence, real-time monitoring, and forensic analysis in one unified platform.**
+
+---
+
+## 🚀 Features
+
+### 🔍 Threat Intelligence Pro
+- **Multi-Source Analysis**: 7 integrated threat intelligence APIs
+- **Domain/IP/File Scanning**: Comprehensive threat assessment
+- **Real-Time Scoring**: Advanced multi-source threat scoring system
+- **Export Capabilities**: PDF/JSON report generation
+
+### 🛡️ Real-Time Protection
+- **File Monitoring**: Automatic scanning of new files
+- **Auto-Quarantine**: Isolate malicious files automatically
+- **Watchdog Integration**: Real-time directory monitoring
+
+### 📊 Security Modules
+- **Personal Security**: Breach monitoring & password analysis
+- **System Audit**: Startup programs & process inspection
+- **Forensics Lite**: Evidence collection & browser history
+- **Network Tools**: Host discovery & port scanning
+
+---
+
+## 🏗️ Architecture
+
+CyberGuardian-X/
+├── apis/ # Threat Intelligence API Clients
+├── core/ # Core Engine & Utilities
+├── gui/ # PyQt6 User Interface
+├── modules/ # Security Modules
+├── database/ # SQLite Data Storage
+└── assets/ # Icons & Resources
+
+text
+
+---
+
+## 🔧 Installation
+
+### Option 1: Download Executable (Recommended)
+1. Go to [Releases](https://github.com/APMarzuki/CyberGuardian-X/releases)
+2. Download `CyberGuardian-X.exe`
+3. Run directly - no installation required
+
+### Option 2: Build from Source
+```bash
+# Clone repository
+git clone https://github.com/APMarzuki/CyberGuardian-X.git
+cd CyberGuardian-X
+
+# Create virtual environment
+python -m venv .venv
+.venv\Scripts\activate  # Windows
+# source .venv/bin/activate  # Linux/Mac
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run application
+python app.py
+⚙️ Configuration
+Copy configuration template:
+
+bash
+cp keys.example.ini config.ini
+Add your API keys to config.ini:
+
+ini
+[API_KEYS]
+VIRUSTOTAL_API_KEY = your_virustotal_key_here
+OTX_API_KEY = your_otx_key_here
+ABUSEIPDB_API_KEY = your_abuseipdb_key_here
+SHODAN_API_KEY = your_shodan_key_here
+URLSCAN_API_KEY = your_urlscan_key_here
+HYBRIDANALYSIS_API_KEY = your_hybrid_analysis_key_here
+METADEFENDER_API_KEY = your_metadefender_key_here
+Get FREE API Keys:
+
+VirusTotal - 500 requests/day
+
+AbuseIPDB - 1,000 requests/day
+
+OTX AlienVault - Unlimited
+
+Shodan - Limited results
+
+URLScan - Free tier available
+
+Hybrid Analysis - Free account
+
+MetaDefender - Free tier
+
+🎯 Usage
+GUI Application
+bash
+# Launch the application
+python app.py
+# or
+CyberGuardian-X.exe
+Command Line Interface
+bash
+# Scan a domain
+python -m cli.cli scan-domain example.com
+
+# Scan an IP address
+python -m cli.cli scan-ip 8.8.8.8
+
+# Scan a file
+python -m cli.cli scan-file suspicious_file.exe
+Real-Time Monitoring
+Enable in Settings → Real-Time Monitoring
+
+Monitors Downloads and Desktop by default
+
+Automatically scans new files
+
+Quarantines high-threat files
+
+🔍 Supported Threat Intelligence APIs
+Service	Type	Free Tier
+VirusTotal	File/Domain/IP Reputation	500 req/day
+OTX AlienVault	Threat Intelligence	Unlimited
+AbuseIPDB	IP Reputation	1,000 req/day
+Shodan	Internet Intelligence	Limited
+URLScan	Website Analysis	Free tier
+Hybrid Analysis	Malware Analysis	Free account
+MetaDefender	Multi-Antivirus	Free tier
+🛡️ Security Features
+API Key Protection: Never committed to repository
+
+Local Cache: Reduces API calls and improves performance
+
+Rate Limiting: Respects API limits automatically
+
+Quarantine System: Isolates malicious files securely
+
+Encrypted Config: Optional configuration encryption
+
+📊 Screenshots
+Threat Intelligence Dashboard
+Real-Time Monitoring Settings
+Scan Results with Threat Scoring
+
+🏗️ Development
+Project Structure
+text
+CyberGuardian-X/
+├── apis/              # API clients (VT, OTX, AbuseIPDB, etc.)
+├── core/              # Core functionality
+│   ├── config_manager.py
+│   ├── threat_score.py
+│   ├── watchdog_monitor.py
+│   └── logger.py
+├── modules/           # Security modules
+│   ├── threat_intel/  # Threat intelligence
+│   ├── forensic_lite/ # Forensics tools
+│   ├── net_scanner/   # Network scanning
+│   └── system_audit/  # System analysis
+├── gui/               # PyQt6 interface
+├── database/          # SQLite storage
+└── assets/            # Resources
+Building from Source
+bash
+# Install dependencies
+pip install -r requirements.txt
+
+# Build executable
+pyinstaller --name CyberGuardian-X --windowed --onefile --icon=assets/logo.ico app.py
+🤝 Contributing
+Fork the repository
+
+Create a feature branch (git checkout -b feature/amazing-feature)
+
+Commit your changes (git commit -m 'Add amazing feature')
+
+Push to the branch (git push origin feature/amazing-feature)
+
+Open a Pull Request
+
+📝 License
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+⚠️ Disclaimer
+This tool is for educational and legitimate security purposes only. Users are responsible for complying with all applicable laws and API terms of service. The developers are not responsible for any misuse or damage caused by this program.
+
+🏆 Achievements
+✅ 7 Integrated Threat Intelligence APIs
+
+✅ Real-Time File Monitoring
+
+✅ Professional GUI Interface
+
+✅ Standalone Executable
+
+✅ Multi-Source Threat Scoring
+
+✅ Automated Quarantine System
+
+📞 Support
+Issues: GitHub Issues
+
+Discussions: GitHub Discussions
+
+CyberGuardian-X - Your unified shield against cyber threats! 🛡️
+
+text
+
+### **3. Create requirements.txt** (if not exists)
+```txt
+PyQt6>=6.3
+requests>=2.28
+dnspython>=2.3
+python-whois>=0.9
+cryptography>=41.0
+psutil>=5.9
+rich>=12.6
+tldextract>=3.4
+pyinstaller>=5.10
+python-magic-bin; sys_platform == "win32"
+pillow>=10.0
+watchdog>=3.0.0
diff --git a/release_v1.0.0/requirements.txt b/release_v1.0.0/requirements.txt
@@ -0,0 +1,12 @@
+PyQt6>=6.3
+requests>=2.28
+dnspython>=2.3
+python-whois>=0.9
+cryptography>=41.0
+psutil>=5.9
+rich>=12.6
+tldextract>=3.4
+pyinstaller>=5.10
+python-magic-bin; sys_platform == "win32"
+pillow>=10.0
+watchdog>=3.0.0  # ← ADD THIS LINE
