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.4.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

immich_face_to_album-1.0.4-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for immich_face_to_album-1.0.4.tar.gz
Algorithm Hash digest
SHA256 b6596b6c56f90035b16b8afcee5415cb07b74cbe68a7901f7ba7943a0d8046cb
MD5 05c8b9297469644a34fa041955bb2be3
BLAKE2b-256 e5c967cb0b6e6ab82702af2b3681a0ee500b7cef12924a5bff2594a91b32847b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for immich_face_to_album-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 70c16a99e42d10a088ae8fcf3753de9ff52921621d746150c59d2b6e1948b48e
MD5 7b6a718b2158aceadefa2f4af3c46001
BLAKE2b-256 b652c0408005113d4ebc8105d4f5b5bab3e3a35fa73592a5e96ffe0eedfdb81c

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