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

Uploaded Source

Built Distribution

immich_face_to_album-1.0.9-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for immich_face_to_album-1.0.9.tar.gz
Algorithm Hash digest
SHA256 61c1a2ca740aec00569393b8fd274f9269ac3ebac3910032d5d98664aba14a78
MD5 17ed12d6fd130fa057dfe35e67b723b7
BLAKE2b-256 49dec7b003704e433baf4a0015fcba3e717f565873c456748492fcd82e2ebf03

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_face_to_album-1.0.9.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.9-py3-none-any.whl.

File metadata

File hashes

Hashes for immich_face_to_album-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 9942ee1ac27824d70fc27a47aaf3706001e793a3aaf81d2b7ec7e2e5c2ba1c41
MD5 3384044bd75a9c0c03f5800e07a88519
BLAKE2b-256 8920e14a2134a60e73502e7ae221390262edd2a057a1456fa65253b3c8382656

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_face_to_album-1.0.9-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page