# 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:
```sh
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.
```sh
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:
```sh
0 * * * * immich-face-to-album --key your-key --server your-server-url --face face-id --album album-id
```
Raw data
{
"_id": null,
"home_page": "https://github.com/romainrbr/immich-face-to-album",
"name": "immich-face-to-album",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "immich",
"author": "romainrbr",
"author_email": "contact@romain.tech",
"download_url": "https://files.pythonhosted.org/packages/8b/b7/bb753569e4790bc6c4d2b9f0dbd792c4c51034f1b281d031cf7bb69e8fa1/immich_face_to_album-1.0.5.tar.gz",
"platform": null,
"description": "\n# Immich-Face-To-Album\n\nThe '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. \n\n## Installation\n\nBuilt as a Python package, it can be installed using pip:\n\n```sh\npip install immich-face-to-album\n```\n\n## Usage\n\nStart 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.\n\nTo use the tool, you need your API key, Immich server url, face id and album id.\n\n```sh\nimmich-face-to-album --key xxxxx --server https://your-immich-instance.com --face xxxxx --album xxxxx\n```\n\nMake 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`.\n\nYou can run the command multiple times to add different faces to the same album.\n\n\n### On a schedule\n\nThe easiest way to keep face(s) synced with an album is to create a cron job that runs the command on a schedule. \n\nFor example, to run the command every hour, you can add the following to your crontab:\n\n```sh\n0 * * * * immich-face-to-album --key your-key --server your-server-url --face face-id --album album-id\n```\n",
"bugtrack_url": null,
"license": "WTFPL",
"summary": "Tool to import a user's face from Immich into an album, mimicking the Google Photos \"auto-updating album\" feature.",
"version": "1.0.5",
"project_urls": {
"Download": "https://github.com/romainrbr/immich-face-to-album/archive/v_01.tar.gz",
"Homepage": "https://github.com/romainrbr/immich-face-to-album"
},
"split_keywords": [
"immich"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dabacbdbc8cc8b2febeaeb6ee8e6197b5f79a87c1e2bae55fd6cc791e882c9d6",
"md5": "f04cc018723bece8669c539dc307b5a9",
"sha256": "5f94662d509295104253454ae9b0baa7927a31a7acbc684bab1e0073d6dc72ec"
},
"downloads": -1,
"filename": "immich_face_to_album-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f04cc018723bece8669c539dc307b5a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4330,
"upload_time": "2024-10-20T19:52:44",
"upload_time_iso_8601": "2024-10-20T19:52:44.813274Z",
"url": "https://files.pythonhosted.org/packages/da/ba/cbdbc8cc8b2febeaeb6ee8e6197b5f79a87c1e2bae55fd6cc791e882c9d6/immich_face_to_album-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8bb7bb753569e4790bc6c4d2b9f0dbd792c4c51034f1b281d031cf7bb69e8fa1",
"md5": "6098c71e4d41636f624f793b9a658496",
"sha256": "dd56689df5369da8721bf17a9fc7f3a30fbb93d4882ddf01919d6554e9f9b094"
},
"downloads": -1,
"filename": "immich_face_to_album-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "6098c71e4d41636f624f793b9a658496",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3673,
"upload_time": "2024-10-20T19:52:46",
"upload_time_iso_8601": "2024-10-20T19:52:46.334279Z",
"url": "https://files.pythonhosted.org/packages/8b/b7/bb753569e4790bc6c4d2b9f0dbd792c4c51034f1b281d031cf7bb69e8fa1/immich_face_to_album-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 19:52:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "romainrbr",
"github_project": "immich-face-to-album",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "immich-face-to-album"
}
JSON
