Skip to content

Commit b65d688

Browse files
MohitSutharOfficialMohitSutharOfficial
committed
Clean project structure and add automated build with GitHub Actions
0 parents  commit b65d688

15 files changed

+4867
-0
lines changed

‎.github/workflows/build-release.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Build and Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: windows-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v3
16+
17+
- name: Set up Python
18+
uses: actions/setup-python@v4
19+
with:
20+
python-version: '3.11'
21+
22+
- name: Install dependencies
23+
run: |
24+
python -m pip install --upgrade pip
25+
pip install -r requirements.txt
26+
pip install pyinstaller
27+
28+
- name: Build executable
29+
run: |
30+
pyinstaller --clean --noconfirm --name=SecurityScanner --onefile --windowed --add-data="security_scanner_core.py;." --hidden-import=tkinter --hidden-import=tkinter.ttk --hidden-import=requests --hidden-import=bs4 --hidden-import=urllib3 --hidden-import=ssl --hidden-import=socket --hidden-import=datetime --hidden-import=threading --hidden-import=json --hidden-import=dns --hidden-import=whois enhanced_security_scanner.py
31+
32+
- name: Create release package
33+
run: |
34+
Copy-Item "dist\SecurityScanner.exe" -Destination "RELEASE_PACKAGE\"
35+
Compress-Archive -Path "RELEASE_PACKAGE\*" -DestinationPath "SecurityScanner-v2.1-Release.zip"
36+
37+
- name: Create Release
38+
uses: softprops/action-gh-release@v1
39+
with:
40+
files: SecurityScanner-v2.1-Release.zip
41+
body: |
42+
# Enhanced Security Scanner v2.1 - Professional Edition
43+
44+
## Download and Run
45+
1. Download `SecurityScanner-v2.1-Release.zip`
46+
2. Extract to any folder
47+
3. Run `SecurityScanner.exe`
48+
4. No Python installation required!
49+
50+
## Features
51+
- Complete security analysis (DNS, Headers, Ports, SSL/TLS, Vulnerabilities)
52+
- Professional workflow visualization
53+
- Multi-tab results interface
54+
- Export reports (TXT, JSON, HTML)
55+
- Web data extraction
56+
57+
## Requirements
58+
- Windows 7/8/10/11 (64-bit)
59+
- 512 MB RAM minimum
60+
- Internet connection for scanning
61+
62+
## Important
63+
Only scan websites you own or have permission to test.
64+
env:
65+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Python
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
*.so
6+
.Python
7+
8+
# Build folders
9+
build/
10+
dist/
11+
*.egg-info/
12+
SecurityScanner/
13+
14+
# PyInstaller
15+
*.manifest
16+
*.spec
17+
18+
# Environments
19+
.env
20+
.venv
21+
env/
22+
venv/
23+
24+
# IDE
25+
.vscode/
26+
.idea/
27+
*.swp
28+
*.swo
29+
30+
# OS
31+
.DS_Store
32+
Thumbs.db
33+
34+
# Release
35+
*.zip
36+
*.exe
37+
38+
# Keep these
39+
!RELEASE_PACKAGE/*.exe
40+
!RELEASE_PACKAGE/*.bat

‎PROJECT_READY.md‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# ✅ PROJECT CLEANED UP SUCCESSFULLY!
2+
3+
## What I Did
4+
5+
### 🗑️ Removed Unnecessary Files:
6+
- ✓ Old build scripts (build_executable.py, launch_scanner.py)
7+
- ✓ Development documentation (15+ old docs files)
8+
- ✓ Cache folders (__pycache__, build/, SecurityScanner/)
9+
- ✓ Duplicate/outdated files
10+
- ✓ Old scraper scripts
11+
12+
### ✨ Organized Project Structure:
13+
```
14+
Your Clean Project:
15+
├── enhanced_security_scanner.py ← Main app
16+
├── security_scanner_core.py ← Core logic
17+
├── requirements.txt ← Dependencies
18+
├── SecurityScanner.spec ← Build config
19+
├── setup_helper.bat ← START HERE!
20+
├── build_and_release.bat ← Build script
21+
├── README.md ← GitHub README
22+
├── QUICKSTART.md ← Quick guide
23+
└── RELEASE_PACKAGE/ ← Release files
24+
```
25+
26+
### 📝 Updated Files:
27+
- ✓ .gitignore (proper Python/build exclusions)
28+
- ✓ setup_helper.bat (streamlined setup)
29+
- ✓ README.md (professional GitHub README)
30+
- ✓ All release documentation ready
31+
32+
---
33+
34+
## 🎯 WHAT TO DO NOW
35+
36+
### Option 1: Python Already Installed?
37+
```
38+
Run: setup_helper.bat
39+
(It will detect Python and start building)
40+
```
41+
42+
### Option 2: Python NOT Installed?
43+
```
44+
Run: setup_helper.bat
45+
(It will open Python download page and guide you)
46+
```
47+
48+
---
49+
50+
## 🚀 The Process
51+
52+
### 1. Setup Helper Script Will:
53+
- Check if Python is installed
54+
- If NOT: Open download page with instructions
55+
- If YES: Start build automatically
56+
57+
### 2. Build Script Will:
58+
- Install required packages
59+
- Build SecurityScanner.exe
60+
- Create release package
61+
- Generate ZIP file
62+
63+
### 3. You Get:
64+
- `SecurityScanner-v2.1-Release.zip` ready to upload!
65+
- All files in RELEASE_PACKAGE folder
66+
- Ready for GitHub release!
67+
68+
---
69+
70+
## 📊 File Count
71+
72+
**Before Cleanup:** ~50+ files
73+
**After Cleanup:** 10 essential files
74+
75+
Your project is now:
76+
- ✅ Clean and professional
77+
- ✅ Easy to understand
78+
- ✅ Ready for release
79+
- ✅ Well-documented
80+
81+
---
82+
83+
## 🎬 Next Step
84+
85+
### **RIGHT NOW:**
86+
87+
1. **Double-click:** `setup_helper.bat`
88+
89+
2. **If Python not installed:**
90+
- Download from opened browser page
91+
- Install with "Add to PATH" checked
92+
- Run setup_helper.bat again
93+
94+
3. **Wait ~10 minutes for build**
95+
96+
4. **Upload to GitHub:**
97+
- Go to releases
98+
- Upload SecurityScanner-v2.1-Release.zip
99+
- Done!
100+
101+
---
102+
103+
## 📁 Files Explained
104+
105+
| File | Purpose |
106+
|------|---------|
107+
| `setup_helper.bat` | Main entry point - START HERE |
108+
| `build_and_release.bat` | Builds exe and creates release |
109+
| `enhanced_security_scanner.py` | Your application code |
110+
| `security_scanner_core.py` | Security scanning logic |
111+
| `requirements.txt` | Python dependencies list |
112+
| `SecurityScanner.spec` | PyInstaller build config |
113+
| `README.md` | GitHub project page |
114+
| `QUICKSTART.md` | This file - your guide |
115+
| `RELEASE_PACKAGE/` | Files that users will get |
116+
117+
---
118+
119+
## 🎉 Summary
120+
121+
**Your project is READY!**
122+
123+
- ✅ All unnecessary files removed
124+
- ✅ Professional structure
125+
- ✅ Clear documentation
126+
- ✅ Easy build process
127+
- ✅ Ready for release
128+
129+
**Just run:** `setup_helper.bat` and follow the prompts!
130+
131+
---
132+
133+
**Questions?**
134+
- Check QUICKSTART.md (this file)
135+
- Check README.md (project overview)
136+
- Check RELEASE_PACKAGE/USER_GUIDE.md (detailed manual)
137+
138+
**Good luck with your release!** 🚀✨

0 commit comments

Comments
 (0)