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 repeat the --face multiple times to add multiple 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.13.tar.gz (19.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_face_to_album-1.0.13-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for immich_face_to_album-1.0.13.tar.gz
Algorithm Hash digest
SHA256 23f23f59366ddb141c23821a8c8ec3672e6330d0d09d88c7f30f3d4bf1782d35
MD5 30b90e726e7be149f12473a7fa6b55ab
BLAKE2b-256 ce1f9b67d8f12f405a47ffc4c6abfcd97b0bcc1785a2364f01f123d8d5f792e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_face_to_album-1.0.13.tar.gz:

Publisher: release-to-pip.yml on romainrbr/immich-face-to-album

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_face_to_album-1.0.13-py3-none-any.whl.

File metadata

File hashes

Hashes for immich_face_to_album-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 418843897e9ecf6c41c2b23f3ba4d8cd5a2a87c00c0305f4b455d6ca7cd97979
MD5 ea763837dc4edeb682991e2324c567e2
BLAKE2b-256 66a8018104484a609f6f18fe81fae629166c17744e3dc4333feb9ced97dea258

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_face_to_album-1.0.13-py3-none-any.whl:

Publisher: release-to-pip.yml on romainrbr/immich-face-to-album

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