Skip to main content

A Python library and CLI tool for interacting with Immich

Project description

Coverage Status

Immich Lib

A Python library and CLI tool for interacting with an Immich server.

Installation

pip install .

CLI Usage

After installation, you can use the immich-tool command:

immich-tool list-albums
immich-tool download-album "My Album"

You can also pass the URL and API key as arguments:

immich-tool --url http://immich.local:2283 --key YOUR_API_KEY list-albums

Or set them in your environment or a .env file:

IMMICH_SERVER_URL=http://immich.local:2283
IMMICH_API_KEY=YOUR_API_KEY

Library Usage

from immich_lib import ImmichClient

client = ImmichClient("http://immich.local:2283", "YOUR_API_KEY")
albums = client.list_albums()
for album in albums:
    print(album['albumName'])

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_lib-0.2.1.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

immich_lib-0.2.1-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file immich_lib-0.2.1.tar.gz.

File metadata

  • Download URL: immich_lib-0.2.1.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immich_lib-0.2.1.tar.gz
Algorithm Hash digest
SHA256 29848b16a8d6672fab3e549927d221d2019921932edafbb6c2a2739fc9419733
MD5 d16e45af10fc74800d52b82c84163cdd
BLAKE2b-256 71046ccd718e440fd6314e55f6074ae52cf4a16b67d5dcbfa5f890703fc3d633

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_lib-0.2.1.tar.gz:

Publisher: publish.yml on guanana/immich-lib

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_lib-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: immich_lib-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immich_lib-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e05e0d2f6b5c51ce7acd44c58174946044aa4b1c64f7f9ae32fc124b0914aebf
MD5 8ebab660b811504a715bb0b610f681ed
BLAKE2b-256 0907235936906d7fe72316079e43d90790247c3e1d91f3c910051ba3ee9eee2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_lib-0.2.1-py3-none-any.whl:

Publisher: publish.yml on guanana/immich-lib

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