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.14.tar.gz (20.1 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.14-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for immich_face_to_album-1.0.14.tar.gz
Algorithm Hash digest
SHA256 8315c5a8f8170f40988aac77762e4c0b182e6136551048a1f81339708059c0d7
MD5 99f2ff926ffabddaaddfcdd278d89a1b
BLAKE2b-256 df25f60e213abb9d07e85dcef7f57fbea401ecbb647b412ee5894dcc232ab17b

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for immich_face_to_album-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 1ecde305f2faf194998fcb8f1cfa76269adbaa6ce291aae1e3699d1a555a734f
MD5 cd9f70dc8f8f60bfd7e5a9dc438fad23
BLAKE2b-256 316489c88e8faccf08324fa0076b6adbe739518cf37e6f97fb1df66b08d046d9

See more details on using hashes here.

Provenance

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