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.3.0.tar.gz (33.9 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.3.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for birdpreen-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ac9711149e9c5b6f98f597e3808a809cb1135d2cb535369da8868b7a939720f1
MD5 55aed29686abbcdcc4607814aca55748
BLAKE2b-256 640ecf05eefe7d19ac55d07b5fe6a252faf6382e6e804846756716b0b4eb3a78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: birdpreen-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 31.4 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a75c4bbb5df61483006603db00662b5c8a95fff471bbb84d5da096b99b3af0e
MD5 1e1859724e40ad6da113c1a3e847cf42
BLAKE2b-256 00532cd6323fafed4968e659e2632006501d278346e7d49d1c7316d94b380658

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