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.0.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.0-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: immich_lib-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 0fde6fdd175103267219f0bd212d9053f73707018fdf8282cccca94e3da6054e
MD5 5816485d32869609236de548934f59e3
BLAKE2b-256 5acb1469600c1a98ccb7731f6596c7df87c8465eed28e434a84d9d81d842edea

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_lib-0.2.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: immich_lib-0.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 932e2e8147fcb8963caf8395503bf44f7264318c34478b710f1805595ad48e05
MD5 ab67eaf956fbf20b9c00daafa9e569b7
BLAKE2b-256 f3dcdc47e5ef9239d02d58b94db192eeae98b296d258eec5a713f6a3e1241741

See more details on using hashes here.

Provenance

The following attestation bundles were made for immich_lib-0.2.0-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