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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file immich-face-to-album-1.0.1.tar.gz.

File metadata

  • Download URL: immich-face-to-album-1.0.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for immich-face-to-album-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6d20f982ec2ce8c76d0a6a85af3eafd1c3e9978d1b0a4a83f61684f722f52ebd
MD5 b538f7fd17cf585d436ef7d9fd28484f
BLAKE2b-256 a495b1f668a85173df6d24d89a8d6c6cae4250eea9174078bfda3ea1cc35ee7e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for immich_face_to_album-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb7fd87b62298a7248e3fb4269051673e60ab3ed2cff5526a2d4cd3db61c68fa
MD5 9e630a09f406bfbb82a51c9615db435a
BLAKE2b-256 90ba94f49a9138373357902638b438615bf005fcbe168c2e1785dcfda9d4de31

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