Skip to main content

Scan macOS Photos library, detect and identify birds, write species captions

Project description

preen

Groom your photo library — automatically find and name every bird.

Preen scans your macOS Photos library, detects birds with YOLO, identifies species with SuperPicky's OSEA classifier (10,964 species), and writes "中文名 (English Name)" as captions — visible on iPhone.

Features

  • Scans entire Photos library including iCloud photos
  • YOLO multi-bird detection — finds all birds in a photo
  • OSEA species identification with GPS-based eBird regional filtering
  • Writes captions via persistent Photos.app connection (photoscript)
  • SQLite checkpoint — pause/resume, incremental or full rescan
  • Deduplicates species in multi-bird captions

Requirements

  • macOS with Photos.app
  • Python 3.11+

Installation

pipx install birdpreen

Or with pip:

pip install birdpreen

On first scan, model files (~260 MB) are automatically downloaded from HuggingFace.

Usage

# Scan new photos (incremental)
preen scan

# Full library rescan
preen scan --full

# Dry run — detect and identify without writing
preen scan --dry-run

# Custom confidence threshold (default: 70%)
preen scan --threshold 65

# Process in batches
preen scan --batch-size 500

# Check progress
preen status

# Reset checkpoint to start over
preen reset

Credits

  • OSEA bird classification model (10,964 species) by Sun Jiao
  • Bird identification logic (OSEA classifier, AVONET geographic filtering, eBird species data) extracted from SuperPicky
  • YOLO11 segmentation model by Ultralytics
  • Photos library access via osxphotos
  • Photos.app integration via photoscript

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

birdpreen-0.2.1.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

birdpreen-0.2.1-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file birdpreen-0.2.1.tar.gz.

File metadata

  • Download URL: birdpreen-0.2.1.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for birdpreen-0.2.1.tar.gz
Algorithm Hash digest
SHA256 aebc85c2ef59cf188ccb7e0d410af3d6474f581b271683967b30966b67fa5a41
MD5 de2002009b5403e8abd8152b9a57fb17
BLAKE2b-256 771369a32c28c07b7a9a778123c2bef511d9ae29027a492bb7fbf26e3520eb2d

See more details on using hashes here.

File details

Details for the file birdpreen-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: birdpreen-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 31.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for birdpreen-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2760c6d018a24a50ad935ec8b23522a273234c5748bad108f9f83bb41c01d07d
MD5 92335f57fd4b276725ddd2a5d64cc5f7
BLAKE2b-256 ceeac1bedc7af0185ebcf3959a085a62361d4da3ec5613d3092c50dd849196e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page