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.2.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.2-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: birdpreen-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 39359e680227893b5042cf90df838f3989f0263d59b443c22d9300ad5b7ad546
MD5 324d2f04e3381a144a0bdd6f4904c1f3
BLAKE2b-256 facffa4e108c69fadeb2c98b37031abf402b2b7421be354d77135a9f30c95270

See more details on using hashes here.

File details

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

File metadata

  • Download URL: birdpreen-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 31.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ce15eb2f0fd280e4647f91f3740d525cfbb90540a1e97d90d5da19211745bab8
MD5 d591a30ad43e93eb211f434ac9200b34
BLAKE2b-256 093369a83e266e0d59238b99256538344cefa31eadb780a6bad29d669d823411

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