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.11.0.tar.gz (444.4 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.11.0-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: winnow_media-0.11.0.tar.gz
  • Upload date:
  • Size: 444.4 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.11.0.tar.gz
Algorithm Hash digest
SHA256 beeb3eaea195a8089848f0a0abd2695914242a4a2f110425ec7eddc48d95f9f0
MD5 3bb526cf6d3682605bd6a157bda74190
BLAKE2b-256 5f48f7ccdc324f74296c33ff912aa43a2c4b0d367d1ff0938260894ee9ca550a

See more details on using hashes here.

Provenance

The following attestation bundles were made for winnow_media-0.11.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.11.0-py3-none-any.whl.

File metadata

  • Download URL: winnow_media-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 65.1 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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a1a1d1f2438faec762c7e9d67e63c09ca53fda18314d42f09a2dcd4f72e0b62
MD5 4a0ce1cb11d06cdf1a0f94d14be8f474
BLAKE2b-256 033fa13ec5a522d445b826399b4c66b49e4ecc697edf98081e3e49eec91fe5a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for winnow_media-0.11.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