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

Uploaded Source

Built Distribution

immich_face_to_album-1.0.6-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: immich_face_to_album-1.0.6.tar.gz
  • Upload date:
  • Size: 3.8 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.6.tar.gz
Algorithm Hash digest
SHA256 0415104eafa1cd340d63592384c747747f97e2fdeba75417ea8efe5a24705c19
MD5 f94e1d5a941298de4abe15aee815f39c
BLAKE2b-256 6b758ceb491a32c93618c09a16f3c975f39fac8400fca79a110535c871aa5e2e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for immich_face_to_album-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 30f060ef1c503405a046e1423fa080b47cbda9ffadfeb399440043d91dde8ad4
MD5 c059c6c40e52c232bb96ec93fc874f0e
BLAKE2b-256 6729a87848e8f5d54498966fd4f6952b329d7bd6997f1ce05f22ad46752226bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_face_to_album-1.0.6-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