Skip to main content

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

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.15.tar.gz (20.9 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.15-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for immich_face_to_album-1.0.15.tar.gz
Algorithm Hash digest
SHA256 f32739ebab40141ed325c0e8ac581c8265df2542521d3fc80abf031184a136c0
MD5 0e823a1c184d0740c598e415e64673e2
BLAKE2b-256 d30e44f7314a04e9e360a7c2a231b4d13d4b2468594ab94ec431df53491cd4c0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for immich_face_to_album-1.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 f24583ef501ac0483d7bdd1076525f580a0309aa8e07e2346900c1f2b5729698
MD5 ad39161b77df9bb11d71b4e2037e0768
BLAKE2b-256 0a134fe882598fee32d5328e4fd02450ea7c70da1be3424413547f644ec2b978

See more details on using hashes here.

Provenance

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

Release history Release notifications | RSS feed

1.0.16

2 files

This release

1.0.15 This release

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

1 file

1.0.2

1 file

1.0.1

2 files

1.0.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page