Skip to main content

Winnow your media library — organize photos and videos, detect duplicates, and keep the best copies.

Project description

Winnow

CI PyPI CodeQL OpenSSF Scorecard License: MIT Python 3.11+

Winnow your media library — organize photos and videos, detect duplicates, and keep the best copies. Local-first, offline-capable, and designed as a greenfield rewrite of py-organizer.

Status

Pre-alpha. The published CLI is a skeleton: winnow, winnow --help, and winnow --version are the only user-facing commands today. Domain models, exception types, and CI are in place; scanning, deduplication, and organization workflows are tracked in open issues (see #2 for the parent epic).

Install

Requirements: Python 3.11+ and a package manager (uv recommended).

From PyPI

Use uv's project workflow so the dependency and command run from the same managed environment:

uv init winnow-demo
cd winnow-demo
uv add winnow-media
uv run winnow --version

Optional dependency groups (face, cv, ai-detect) are declared in pyproject.toml but not wired to features yet.

From source

git clone https://github.com/lgtm-hq/winnow.git
cd winnow
make setup    # uv sync --dev
uv run winnow --help

Docker

docker pull ghcr.io/lgtm-hq/winnow:latest
docker run --rm ghcr.io/lgtm-hq/winnow:latest --version

Images are published to ghcr.io/lgtm-hq/winnow on merges to main and on version tags. Platforms: linux/amd64 and linux/arm64.

Usage

Only the commands below work in the current release. There are no media-processing subcommands yet.

uv run winnow              # prints version and points to --help
uv run winnow --help       # show available options
uv run winnow --version    # print package version

Example output:

$ uv run winnow
winnow 0.2.0 — use --help for commands.

$ uv run winnow --version
winnow, version 0.2.0

Planned usage (not implemented)

Future releases will add subcommands for scanning libraries, grouping duplicates, and applying organization rules. Shapes will follow the domain models in winnow/models/ and the API-first plan in ADR 0001. Do not expect the examples below to work today:

# PLANNED — not available yet
uv run winnow scan /path/to/photos
uv run winnow duplicates review
uv run winnow organize --dry-run

Features

Available now

  • Skeleton CLI — Click entry point with --help and --version
  • Domain models — Pydantic v2 models for media files, duplicates, pipeline steps, and configuration (winnow/models/)
  • Exception hierarchy — structured errors with context (winnow/exceptions.py)
  • Quality bar — lintro lint/format, 85% test coverage gate, multi-version CI

Roadmap

Winnow follows an API-first, CLI-first phasing plan:

Phase Focus Highlights
Now Foundation Models, CLI skeleton, CI/CD, ADRs
Phase 1 Core product Scan, dedupe, and organize via CLI and API
Phase 2 Web UI Presentation-only frontend over OpenAPI

Planned capabilities (not shipped):

  • Scan local photo and video libraries with rich metadata extraction
  • Detect duplicates via perceptual hashing and related signals
  • Rank and keep the best copy; organize or quarantine the rest
  • Local SQLite storage; no cloud dependency required
  • OpenAPI schema as the stable integration surface for automation and UI

Track progress on the issue board and in the in-repo documentation.

Development

make setup          # install dev dependencies (uv sync --dev)
make lint           # uv run lintro chk
make fmt            # uv run lintro fmt
make test           # pytest with 85% coverage gate
make test-integration  # opt-in integration tests

See CONTRIBUTING.md for commit conventions, signed commits, and PR expectations.

Documentation

License

MIT — see LICENSE.

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

winnow_media-0.12.0.tar.gz (452.6 kB view details)

Uploaded Source

Built Distribution

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

winnow_media-0.12.0-py3-none-any.whl (72.8 kB view details)

Uploaded Python 3

File details

Details for the file winnow_media-0.12.0.tar.gz.

File metadata

  • Download URL: winnow_media-0.12.0.tar.gz
  • Upload date:
  • Size: 452.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for winnow_media-0.12.0.tar.gz
Algorithm Hash digest
SHA256 5b8d02ae42cc5ca9787ef605b5cb336318907a4564cc4a5bb919ad278432cf8d
MD5 9af7f0135ed1697e181b62db9942dfda
BLAKE2b-256 aac2051cf631f003a258740a18757a05635ab76bf9cd57d95ef112507eb48242

See more details on using hashes here.

Provenance

The following attestation bundles were made for winnow_media-0.12.0.tar.gz:

Publisher: publish-pypi-on-tag.yml on lgtm-hq/winnow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file winnow_media-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: winnow_media-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 72.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for winnow_media-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd8b8b000fb27d88df95f013e0fa5cebd743aaea6ab2526e5c539b8111098f66
MD5 6eddfc0e9eb7a604cfee5e95fe5cc206
BLAKE2b-256 d1ac0817e4e656a4273e8d2c03e9c663d228cf87c7f5fe0a5dc858052ae27418

See more details on using hashes here.

Provenance

The following attestation bundles were made for winnow_media-0.12.0-py3-none-any.whl:

Publisher: publish-pypi-on-tag.yml on lgtm-hq/winnow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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