https://github.com/mateu/fox-report
Fox event reporter for frigate
https://github.com/mateu/fox-report
detection fox frigate object
Last synced: 6 months ago
JSON representation
Fox event reporter for frigate
- Host: GitHub
- URL: https://github.com/mateu/fox-report
- Owner: mateu
- License: mit
- Created: 2025-08-03T21:50:27.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-11-27T00:44:09.000Z (8 months ago)
- Last Synced: 2025-11-29T18:47:30.862Z (8 months ago)
- Topics: detection, fox, frigate, object
- Language: Python
- Homepage:
- Size: 11.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **Note**: This project now uses `uv` for Python package management. See [MIGRATION_TO_UV.md](MIGRATION_TO_UV.md) for details.
# 🦊 Fox Detection Report System
A Python-based system for generating and emailing Fox detection reports from Frigate NVR data.
## 📁 Project Structure
```
fox-report/
├── src/ # Source code
│ ├── fox_report/ # Core package
│ │ ├── database_query.py
│ │ ├── report_generator.py
│ │ ├── time_resolver.py
│ │ └── email/ # Email functionality
│ │ └── sender.py
│ └── cli/ # Command-line interface
│ └── send_report.py
├── config/ # Configuration files
│ ├── gmail.yaml
│ └── template.yaml
├── tests/ # Test files
│ ├── unit/
│ └── fixtures/
├── docs/ # Documentation
│ ├── README.md # Detailed technical documentation
│ └── ops.md # Operations and deployment guide
└── pyproject.toml # Dependencies and project configuration
```
## 🚀 Quick Start
1. **Install dependencies:**
```bash
uv sync
```
2. **Configure environment:**
```bash
cp config/.env.example .env
# Edit .env with your Gmail credentials
```
3. **Send a fox report:**
```bash
uv run python send_fox_report_gmail.py --config config/gmail.yaml --nights 3
```
## 📧 Features
- **Mountain Time Support**: All timestamps in local time with DST handling
- **Gmail SMTP**: Direct email sending via Gmail with app passwords
- **Clickable Event IDs**: Direct links to video clips in emails
- **Hierarchical Structure**: Clean, maintainable code organization
- **Comprehensive Testing**: Unit and integration tests
- **Automated Scheduling**: Daily cron job with proper timezone handling
## 🔧 Operations
For deployment, scheduling, and maintenance information, see [`docs/ops.md`](docs/ops.md).
## 📖 Documentation
See the `docs/` directory for detailed documentation:
- [`docs/README.md`](docs/README.md) - Technical documentation and API reference
- [`docs/ops.md`](docs/ops.md) - Operations, deployment, and cron configuration