Skip to content

fix: remove phantom deps from requirements.txt and correct stale README content #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 1 commit into from
Closed

fix: remove phantom deps from requirements.txt and correct stale README content #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Perfect for modern browsers, real-time visual feedback, and team use.

```bash
# 1. Install dependencies
pip install flask
pip install -r requirements.txt

# 2. Run the web server
python web_app.py
Expand Down Expand Up @@ -113,15 +113,18 @@ face-attendance-opencv-python/
│ └── index.html # Web UI (vanilla JS)
│
├── src/
│ ├── face_attendance_app.py # Core recognition engine
│ ├── face_attendance_app.py # Core recognition engine (web)
│ ├── basic_face_recognition.py # Alternate recognition engine (CLI)
│ ├── attendance.py # Attendance tracking
│ ├── face_recognition.py # Face encoding & matching
│ ├── face_recognition.py # Local face encoding & matching (no dlib)
│ ├── utils.py # Utility functions
│ └── main.py # CLI entry point
│
├── ImagesAttendance/ # Enrollment images
├── images/
│ └── Basic/ # Demo images for CLI mode
├── data/
│ └── Attendance/ # Daily CSV records
│ └── Attendance/ # Daily CSV records (auto-created)
│
├── requirements.txt # Dependencies
└── README.md # This file
Expand Down Expand Up @@ -158,8 +161,6 @@ source .venv/bin/activate
pip install -r requirements.txt
```

**Note**: First install of `dlib` may take 5-10 minutes. This is normal.

---

## 🎯 Usage Guide
Expand Down Expand Up @@ -239,7 +240,7 @@ Detect Faces (Haar Cascade)
↓
Extract Face Regions
↓
Generate 128-D Encodings (SIFT features)
Generate 128-D Encodings (HOG-based gradient features)
↓
Compare with Known Encodings
↓
Expand Down Expand Up @@ -295,9 +296,12 @@ Format:
## 🐛 Troubleshooting

### "No module named 'face_recognition'"
The project ships its own local `src/face_recognition.py` module (no installation needed).
If you see this error, make sure you are running the app from the repository root so that
`src/` is on the Python path, or run via the provided entry points:
```bash
pip install face-recognition
# Note: First install takes 5-10 minutes
python web_app.py # web UI
cd src && python main.py # CLI
```

### Webcam not detected
Expand Down Expand Up @@ -346,14 +350,14 @@ ngrok http 5000
```
opencv-python==4.8.1.78 # Computer vision
numpy==1.24.3 # Numerical computing
face-recognition-models # Pre-trained models
face-recognition # Face detection & encoding
dlib>=19.7 # Face detection backend
flask>=2.0.0 # Web server
pandas>=2.0.3 # Data handling
Pillow>=10.0.0 # Image processing
```

> **No heavy external dependencies**: face recognition runs via a built-in local module
> (`src/face_recognition.py`) using OpenCV Haar cascades + HOG features — no dlib or cloud APIs required.

---

## 📄 Output Files
Expand Down
6 changes: 0 additions & 6 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
opencv-python==4.8.1.78
numpy==1.24.3
Pillow>=10.0.0
openpyxl==3.1.2
pandas>=2.0.3
cmake
dlib>=19.7
click
face-recognition-models
face-recognition>=1.3.0
flask>=2.0.0
Loading