immichpy 1.6.5__py3-none-any.whl → 1.7.6__py3-none-any.whl

immichpy/cli/__main__.py

@@ -3,7 +3,7 @@ try:  # pragma: no cover
 except ImportError:  # pragma: no cover
     import sys
 
-    message = 'To use the immich command, install the "cli" extra:\n\n\t- pip install immich[cli]\n\tOR\n\t- uv add immich --extra cli\n'
+    message = 'To use the immichpy command, install the "cli" extra:\n\n\t- pip install immichpy[cli]\n\tOR\n\t- uv add immichpy --extra cli\n'
     print(message, file=sys.stderr)
     sys.exit(1)
 

immichpy/cli/commands/activities.py

@@ -19,10 +19,14 @@ app = typer.Typer(
 @app.command("create-activity", deprecated=False, rich_help_panel="API commands")
 def create_activity(
     ctx: typer.Context,
-    album_id: str = typer.Option(..., "--album-id", help=""""""),
-    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
-    comment: str | None = typer.Option(None, "--comment", help=""""""),
-    type: str = typer.Option(..., "--type", help=""""""),
+    album_id: str = typer.Option(..., "--album-id", help="""Album ID"""),
+    asset_id: str | None = typer.Option(
+        None, "--asset-id", help="""Asset ID (if activity is for an asset)"""
+    ),
+    comment: str | None = typer.Option(
+        None, "--comment", help="""Comment text (required if type is comment)"""
+    ),
+    type: str = typer.Option(..., "--type", help="""Activity type (like or comment)"""),
 ) -> None:
     """Create an activity
 
@@ -62,11 +66,17 @@ def delete_activity(
 @app.command("get-activities", deprecated=False, rich_help_panel="API commands")
 def get_activities(
     ctx: typer.Context,
-    album_id: str = typer.Option(..., "--album-id", help=""""""),
-    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
-    level: ReactionLevel | None = typer.Option(None, "--level", help=""""""),
-    type: ReactionType | None = typer.Option(None, "--type", help=""""""),
-    user_id: str | None = typer.Option(None, "--user-id", help=""""""),
+    album_id: str = typer.Option(..., "--album-id", help="""Album ID"""),
+    asset_id: str | None = typer.Option(
+        None, "--asset-id", help="""Asset ID (if activity is for an asset)"""
+    ),
+    level: ReactionLevel | None = typer.Option(
+        None, "--level", help="""Filter by activity level"""
+    ),
+    type: ReactionType | None = typer.Option(
+        None, "--type", help="""Filter by activity type"""
+    ),
+    user_id: str | None = typer.Option(None, "--user-id", help="""Filter by user ID"""),
 ) -> None:
     """List all activities
 
@@ -92,8 +102,10 @@ def get_activities(
 )
 def get_activity_statistics(
     ctx: typer.Context,
-    album_id: str = typer.Option(..., "--album-id", help=""""""),
-    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
+    album_id: str = typer.Option(..., "--album-id", help="""Album ID"""),
+    asset_id: str | None = typer.Option(
+        None, "--asset-id", help="""Asset ID (if activity is for an asset)"""
+    ),
 ) -> None:
     """Retrieve activity statistics
 

immichpy/cli/commands/albums.py

@@ -21,7 +21,7 @@ app = typer.Typer(
 def add_assets_to_album(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    ids: list[str] = typer.Option(..., "--ids", 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:
@@ -47,8 +47,8 @@ def add_assets_to_album(
 @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=""""""),
-    asset_ids: list[str] = typer.Option(..., "--asset-ids", help=""""""),
+    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:
@@ -76,7 +76,11 @@ def add_users_to_album(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     album_users: list[str] = typer.Option(
-        ..., "--album-users", help="""As a JSON string"""
+        ...,
+        "--album-users",
+        help="""Album users to add
+
+As a JSON string""",
     ),
 ) -> None:
     """Share album with users
@@ -98,12 +102,20 @@ def add_users_to_album(
 @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: str = typer.Option(..., "--album-name", help="""Album name"""),
     album_users: list[str] | None = typer.Option(
-        None, "--album-users", help="""As a JSON string"""
+        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"""
     ),
-    asset_ids: list[str] | None = typer.Option(None, "--asset-ids", help=""""""),
-    description: str | None = typer.Option(None, "--description", help=""""""),
 ) -> None:
     """Create an album
 
@@ -149,7 +161,7 @@ def get_album_info(
     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=""""""
+        None, "--without-assets", help="""Exclude assets from response"""
     ),
 ) -> None:
     """Retrieve an album
@@ -189,12 +201,12 @@ def get_all_albums(
     asset_id: str | None = typer.Option(
         None,
         "--asset-id",
-        help="""Only returns albums that contain the asset
-Ignores the shared parameter
-undefined: get all albums""",
+        help="""Filter albums containing this asset ID (ignores shared parameter)""",
     ),
     shared: Literal["true", "false"] | None = typer.Option(
-        None, "--shared", help=""""""
+        None,
+        "--shared",
+        help="""Filter by shared status: true = only shared, false = only own, undefined = all""",
     ),
 ) -> None:
     """List all albums
@@ -217,7 +229,7 @@ undefined: get all albums""",
 def remove_asset_from_album(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Remove assets from an album
 
@@ -258,15 +270,17 @@ def remove_user_from_album(
 def update_album_info(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    album_name: str | None = typer.Option(None, "--album-name", 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=""""""
+        None, "--album-thumbnail-asset-id", help="""Album thumbnail asset ID"""
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Album description"""
     ),
-    description: str | None = typer.Option(None, "--description", help=""""""),
     is_activity_enabled: Literal["true", "false"] | None = typer.Option(
-        None, "--is-activity-enabled", help=""""""
+        None, "--is-activity-enabled", help="""Enable activity feed"""
     ),
-    order: str | None = typer.Option(None, "--order", help=""""""),
+    order: str | None = typer.Option(None, "--order", help="""Asset sort order"""),
 ) -> None:
     """Update an album
 
@@ -299,7 +313,7 @@ def update_album_user(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     user_id: str = typer.Argument(..., help=""""""),
-    role: str = typer.Option(..., "--role", help=""""""),
+    role: str = typer.Option(..., "--role", help="""Album user role"""),
 ) -> None:
     """Update user role
 

immichpy/cli/commands/api_keys.py

@@ -19,8 +19,10 @@ app = typer.Typer(
 @app.command("create-api-key", deprecated=False, rich_help_panel="API commands")
 def create_api_key(
     ctx: typer.Context,
-    name: str | None = typer.Option(None, "--name", help=""""""),
-    permissions: list[Permission] = typer.Option(..., "--permissions", help=""""""),
+    name: str | None = typer.Option(None, "--name", help="""API key name"""),
+    permissions: list[Permission] = typer.Option(
+        ..., "--permissions", help="""List of permissions"""
+    ),
 ) -> None:
     """Create an API key
 
@@ -102,9 +104,9 @@ def get_my_api_key(
 def update_api_key(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    name: str | None = typer.Option(None, "--name", help=""""""),
+    name: str | None = typer.Option(None, "--name", help="""API key name"""),
     permissions: list[Permission] | None = typer.Option(
-        None, "--permissions", help=""""""
+        None, "--permissions", help="""List of permissions"""
     ),
 ) -> None:
     """Update an API key