Skip to main content

Tool to import a user's face from Immich into an album, mimicking the Google Photos "auto-updating album" feature.

Project description

Immich-Face-To-Album

The 'immich-face-to-album' tool is a CLI-based program that allows you to import a user's face from Immich into an album, in a way similar to the Google photos "auto-updating album" feature.

Installation

Built as a Python package, it can be installed using pip:

pip install immich-face-to-album

Usage

Start by grabbing both the face id and album id from Immich. You can find the face id by clicking on a face in the "Faces" tab, and the album id by clicking on an album in the "Albums" tab. The face id is the last part of the url, and the album id is the last part of the url.

To use the tool, you need your API key, Immich server url, face id and album id.

immich-face-to-album --key xxxxx --server https://your-immich-instance.com --face xxxxx --album xxxxx

Make sure to specify the protocol and port in the server url. For example, if your server is running on port 8080, you should specify the url as http://your-server-url:8080.

You can run the command multiple times to add different faces to the same album.

On a schedule

The easiest way to keep face(s) synced with an album is to create a cron job that runs the command on a schedule.

For example, to run the command every hour, you can add the following to your crontab:

0 * * * * immich-face-to-album --key your-key --server your-server-url --face face-id --album album-id

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

immich_face_to_album-1.0.5.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

immich_face_to_album-1.0.5-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file immich_face_to_album-1.0.5.tar.gz.

File metadata

  • Download URL: immich_face_to_album-1.0.5.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for immich_face_to_album-1.0.5.tar.gz
Algorithm Hash digest
SHA256 dd56689df5369da8721bf17a9fc7f3a30fbb93d4882ddf01919d6554e9f9b094
MD5 6098c71e4d41636f624f793b9a658496
BLAKE2b-256 8bb7bb753569e4790bc6c4d2b9f0dbd792c4c51034f1b281d031cf7bb69e8fa1

See more details on using hashes here.

Provenance

File details

Details for the file immich_face_to_album-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for immich_face_to_album-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5f94662d509295104253454ae9b0baa7927a31a7acbc684bab1e0073d6dc72ec
MD5 f04cc018723bece8669c539dc307b5a9
BLAKE2b-256 dabacbdbc8cc8b2febeaeb6ee8e6197b5f79a87c1e2bae55fd6cc791e882c9d6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page