immichpy 2.0.1__tar.gz → 3.0.0__tar.gz

immichpy-3.0.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: immichpy
+Version: 3.0.0
+Summary: The stable, typed Python API layer for Immich automation and integrations.
+Keywords: immich,photos,backup,client,api,cli,automation,integrations
+Author: Timon Rieger
+Author-email: Timon Rieger <contact@timonrieger.de>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: aiohttp>=3.8.4,<4.0.0
+Requires-Dist: aiohttp-retry>=2.8.3,<3.0.0
+Requires-Dist: pydantic>=2.0.0,<3.0.0
+Requires-Dist: pystatx>=0.1,<0.2
+Requires-Dist: python-dateutil>=2.8.2,<3.0.0
+Requires-Dist: rich>=14.2.0,<15.0.0
+Requires-Dist: typing-extensions>=4.7.1,<5.0.0
+Requires-Dist: uv==0.9.28 ; extra == 'build'
+Requires-Dist: rtoml>=0.13.0,<0.14.0 ; extra == 'cli'
+Requires-Dist: typer>=0.21.1,<0.22.0 ; extra == 'cli'
+Requires-Python: >=3.10
+Project-URL: Repository, https://github.com/timonrieger/immichpy
+Project-URL: Changelog, https://github.com/timonrieger/immichpy/releases
+Provides-Extra: build
+Provides-Extra: cli
+Description-Content-Type: text/markdown
+
+<h1 align="center">immichpy</h1>
+<h3 align="center">The stable, typed Python API layer for <a href="https://immich.app">Immich</a> automation and integrations.</h3>
+<p align="center">
+    <a href="https://pypi.org/project/immichpy" target="_blank">
+        <img src="https://img.shields.io/pypi/v/immichpy?color=blue&label=pypi%20package" alt="Package version">
+    </a>
+    <a href="https://pypi.org/project/immichpy" target="_blank">
+        <img src="https://img.shields.io/pypi/dm/immichpy?color=blue" alt="Downloads">
+    </a>
+    <a href="https://pypi.org/project/immichpy" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/immichpy.svg?color=blue" alt="Supported Python versions">
+    </a>
+    <a href="https://github.com/immich-app/immich/releases" target="_blank">
+        <img src="https://img.shields.io/badge/dynamic/regex?url=https://raw.githubusercontent.com/timonrieger/immichpy/main/IMMICH-VERSION&search=(.*)&replace=v2.4.1%20-%20$1&label=supported%20Immich%20versions&color=blue" alt="Supported Immich version">
+    </a>
+    <img src="https://img.shields.io/github/actions/workflow/status/timonrieger/immichpy/cd.yml?branch=main&event=push&logo=github&label=Continuous%20Delivery&color=blue" alt="CD Status">
+</p>
+
+> [!NOTE]
+> This project is not affiliated with or endorsed by Immich.
+
+## Documentation
+
+For full documentation, visit [immichpy.timonrieger.de](https://immichpy.timonrieger.de).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

immichpy-3.0.0/immichpy/cli/__main__.py

@@ -0,0 +1,12 @@
+try:  # pragma: no cover
+    from .main import app
+except ImportError:  # pragma: no cover
+    import sys
+
+    message = 'To use the immichpy command, install the "cli" extra. See https://immichpy.timonrieger.de/cli/getting-started/ for more information.'
+    print(message, file=sys.stderr)
+    sys.exit(1)
+
+
+def main() -> None:  # pragma: no cover
+    app()

immichpy-3.0.0/immichpy/cli/commands/albums.py

@@ -0,0 +1,331 @@
+"""Generated CLI commands for Albums tag (auto-generated, do not edit)."""
+
+from __future__ import annotations
+
+import typer
+import json
+from typing import Literal, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from immichpy import AsyncClient
+
+from immichpy.cli.runtime import print_response, run_command, set_nested
+from immichpy.client.generated.models import *
+
+app = typer.Typer(
+    help="""An album is a collection of assets that can be shared with other users or via shared links.\n\n[link=https://api.immich.app/endpoints/albums]Immich API documentation[/link]"""
+)
+
+
+@app.command("add-assets-to-album", deprecated=False, rich_help_panel="API commands")
+def add_assets_to_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+) -> None:
+    """Add assets to an album
+
+    [link=https://api.immich.app/endpoints/albums/addAssetsToAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    set_nested(json_data, ["ids"], ids)
+    bulk_ids_dto = BulkIdsDto.model_validate(json_data)
+    kwargs["bulk_ids_dto"] = bulk_ids_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_assets_to_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("add-assets-to-albums", deprecated=False, rich_help_panel="API commands")
+def add_assets_to_albums(
+    ctx: typer.Context,
+    album_ids: list[str] = typer.Option(..., "--album-ids", help="""Album IDs"""),
+    asset_ids: list[str] = typer.Option(..., "--asset-ids", help="""Asset IDs"""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+) -> None:
+    """Add assets to albums
+
+    [link=https://api.immich.app/endpoints/albums/addAssetsToAlbums]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    set_nested(json_data, ["album_ids"], album_ids)
+    set_nested(json_data, ["asset_ids"], asset_ids)
+    albums_add_assets_dto = AlbumsAddAssetsDto.model_validate(json_data)
+    kwargs["albums_add_assets_dto"] = albums_add_assets_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_assets_to_albums", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("add-users-to-album", deprecated=False, rich_help_panel="API commands")
+def add_users_to_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    album_users: list[str] = typer.Option(
+        ...,
+        "--album-users",
+        help="""Album users to add
+
+As a JSON string""",
+    ),
+) -> None:
+    """Share album with users
+
+    [link=https://api.immich.app/endpoints/albums/addUsersToAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    value_album_users = [json.loads(i) for i in album_users]
+    set_nested(json_data, ["album_users"], value_album_users)
+    add_users_dto = AddUsersDto.model_validate(json_data)
+    kwargs["add_users_dto"] = add_users_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_users_to_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("create-album", deprecated=False, rich_help_panel="API commands")
+def create_album(
+    ctx: typer.Context,
+    album_name: str = typer.Option(..., "--album-name", help="""Album name"""),
+    album_users: list[str] | None = typer.Option(
+        None,
+        "--album-users",
+        help="""Album users
+
+As a JSON string""",
+    ),
+    asset_ids: list[str] | None = typer.Option(
+        None, "--asset-ids", help="""Initial asset IDs"""
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Album description"""
+    ),
+) -> None:
+    """Create an album
+
+    [link=https://api.immich.app/endpoints/albums/createAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    set_nested(json_data, ["album_name"], album_name)
+    if album_users is not None:
+        value_album_users = [json.loads(i) for i in album_users]
+        set_nested(json_data, ["album_users"], value_album_users)
+    if asset_ids is not None:
+        set_nested(json_data, ["asset_ids"], asset_ids)
+    if description is not None:
+        set_nested(json_data, ["description"], description)
+    create_album_dto = CreateAlbumDto.model_validate(json_data)
+    kwargs["create_album_dto"] = create_album_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "create_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("delete-album", deprecated=False, rich_help_panel="API commands")
+def delete_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Delete an album
+
+    [link=https://api.immich.app/endpoints/albums/deleteAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "delete_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-album-info", deprecated=False, rich_help_panel="API commands")
+def get_album_info(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+    without_assets: Literal["true", "false"] | None = typer.Option(
+        None, "--without-assets", help="""Exclude assets from response"""
+    ),
+) -> None:
+    """Retrieve an album
+
+    [link=https://api.immich.app/endpoints/albums/getAlbumInfo]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    if without_assets is not None:
+        kwargs["without_assets"] = without_assets.lower() == "true"
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_album_info", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-album-statistics", deprecated=False, rich_help_panel="API commands")
+def get_album_statistics(
+    ctx: typer.Context,
+) -> None:
+    """Retrieve album statistics
+
+    [link=https://api.immich.app/endpoints/albums/getAlbumStatistics]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_album_statistics", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-all-albums", deprecated=False, rich_help_panel="API commands")
+def get_all_albums(
+    ctx: typer.Context,
+    asset_id: str | None = typer.Option(
+        None,
+        "--asset-id",
+        help="""Filter albums containing this asset ID (ignores shared parameter)""",
+    ),
+    shared: Literal["true", "false"] | None = typer.Option(
+        None,
+        "--shared",
+        help="""Filter by shared status: true = only shared, false = not shared, undefined = all owned albums""",
+    ),
+) -> None:
+    """List all albums
+
+    [link=https://api.immich.app/endpoints/albums/getAllAlbums]Immich API documentation[/link]
+    """
+    kwargs = {}
+    if asset_id is not None:
+        kwargs["asset_id"] = asset_id
+    if shared is not None:
+        kwargs["shared"] = shared.lower() == "true"
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_all_albums", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command(
+    "remove-asset-from-album", deprecated=False, rich_help_panel="API commands"
+)
+def remove_asset_from_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
+) -> None:
+    """Remove assets from an album
+
+    [link=https://api.immich.app/endpoints/albums/removeAssetFromAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    set_nested(json_data, ["ids"], ids)
+    bulk_ids_dto = BulkIdsDto.model_validate(json_data)
+    kwargs["bulk_ids_dto"] = bulk_ids_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.albums, "remove_asset_from_album", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command("remove-user-from-album", deprecated=False, rich_help_panel="API commands")
+def remove_user_from_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    user_id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Remove user from album
+
+    [link=https://api.immich.app/endpoints/albums/removeUserFromAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    kwargs["user_id"] = user_id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "remove_user_from_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("update-album-info", deprecated=False, rich_help_panel="API commands")
+def update_album_info(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    album_name: str | None = typer.Option(None, "--album-name", help="""Album name"""),
+    album_thumbnail_asset_id: str | None = typer.Option(
+        None, "--album-thumbnail-asset-id", help="""Album thumbnail asset ID"""
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Album description"""
+    ),
+    is_activity_enabled: Literal["true", "false"] | None = typer.Option(
+        None, "--is-activity-enabled", help="""Enable activity feed"""
+    ),
+    order: str | None = typer.Option(None, "--order", help="""Asset sort order"""),
+) -> None:
+    """Update an album
+
+    [link=https://api.immich.app/endpoints/albums/updateAlbumInfo]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    if album_name is not None:
+        set_nested(json_data, ["album_name"], album_name)
+    if album_thumbnail_asset_id is not None:
+        set_nested(json_data, ["album_thumbnail_asset_id"], album_thumbnail_asset_id)
+    if description is not None:
+        set_nested(json_data, ["description"], description)
+    if is_activity_enabled is not None:
+        set_nested(
+            json_data, ["is_activity_enabled"], is_activity_enabled.lower() == "true"
+        )
+    if order is not None:
+        set_nested(json_data, ["order"], order)
+    update_album_dto = UpdateAlbumDto.model_validate(json_data)
+    kwargs["update_album_dto"] = update_album_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "update_album_info", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("update-album-user", deprecated=False, rich_help_panel="API commands")
+def update_album_user(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    user_id: str = typer.Argument(..., help=""""""),
+    role: str = typer.Option(..., "--role", help="""Album user role"""),
+) -> None:
+    """Update user role
+
+    [link=https://api.immich.app/endpoints/albums/updateAlbumUser]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    kwargs["user_id"] = user_id
+    set_nested(json_data, ["role"], role)
+    update_album_user_dto = UpdateAlbumUserDto.model_validate(json_data)
+    kwargs["update_album_user_dto"] = update_album_user_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "update_album_user", ctx, **kwargs)
+    print_response(result, ctx)