Skip to main content

Turn your Immich photo library into video memory compilations with music and smart cuts

Project description

Immich Memories

CI Release Python 3.11+ License: MIT Docs

Create beautiful yearly video compilations from your Immich photo library.

Immich Memories connects to your self-hosted Immich server, intelligently selects the best moments from your videos, and compiles them into shareable memory videos — perfect for year-end recaps or celebrating specific people in your life.

Full documentation: sam-dumont.github.io/immich-video-memory-generator


Quick Install

# One-liner (no clone needed)
uvx immich-memories --help

# Or clone and install
git clone https://github.com/sam-dumont/immich-video-memory-generator.git
cd immich-video-memory-generator
uv sync

Quick Start

# 1. Configure
mkdir -p ~/.immich-memories
cat > ~/.immich-memories/config.yaml << EOF
immich:
  url: "https://photos.example.com"
  api_key: "your-api-key-here"
EOF

# 2. Launch the UI
immich-memories ui
# Opens at http://localhost:8080

# 3. Or use the CLI
immich-memories generate --year 2024 --person "John" --output ~/Videos/john_2024.mp4

Key Features

  • Immich Integration — Direct REST API connection with face recognition support
  • Smart Clip Selection — Scene detection, interest scoring, duplicate filtering
  • Face-Aware Cropping — Keeps faces centered when converting aspect ratios
  • Hardware Acceleration — NVIDIA NVENC, Apple VideoToolbox, Intel QSV, AMD VAAPI
  • AI Music Generation — ACE-Step or MusicGen with automatic mood detection
  • Audio Ducking — Music lowers automatically during speech
  • Web UI + CLI — 4-step wizard or headless automation
  • Docker & Kubernetes — Containerized deployment with GPU support

Documentation

See the full documentation for:

Development

make dev      # Install all dependencies
make check    # Run all checks (lint, format, typecheck, tests)
make ci       # Full CI pipeline
make help     # Show all available targets

See CONTRIBUTING.md for guidelines.

Disclaimer

This project was developed primarily with AI assistance (Claude by Anthropic). It comes with fewer guarantees than typical open-source software. See DISCLAIMER.md for full details.

License

MIT License — see LICENSE for details.


Made with ❤️ for the Immich community

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

immich_memories-0.5.1.tar.gz (385.3 kB view details)

Uploaded Source

Built Distribution

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

immich_memories-0.5.1-py3-none-any.whl (424.5 kB view details)

Uploaded Python 3

File details

Details for the file immich_memories-0.5.1.tar.gz.

File metadata

  • Download URL: immich_memories-0.5.1.tar.gz
  • Upload date:
  • Size: 385.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immich_memories-0.5.1.tar.gz
Algorithm Hash digest
SHA256 77fa79e5765aeb3aa4716e8de4c8a6aefb953a8f0556859f233ec96dfc902131
MD5 8d5033e0e140386668d224586d7b1717
BLAKE2b-256 8cfc4a4d3abcea832fbc5ebe6404ca9993528153a2669a48c8924ffa9ddb0369

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_memories-0.5.1.tar.gz:

Publisher: release.yml on sam-dumont/immich-video-memory-generator

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

File details

Details for the file immich_memories-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: immich_memories-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 424.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immich_memories-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82d8bbfb78358c211bd3e5a5d1e4b42b70e2f0d84078c44dc2cbead8f96a9464
MD5 3d1d057b0887fdc21d2d585bf0106b88
BLAKE2b-256 db4fbefe37e2ae95585f1c3d44647d0f86fe4326a9ee7cd86edf26d709bc955c

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_memories-0.5.1-py3-none-any.whl:

Publisher: release.yml on sam-dumont/immich-video-memory-generator

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