From 94c34171bd6f3cb89c6c4037354ac7df9bbf9b86 Mon Sep 17 00:00:00 2001 From: timonrieger Date: Wed, 14 Jan 2026 20:33:32 +0100 Subject: [PATCH 1/3] chore: update project references and user agent for renaming - Changed repository and changelog URLs in pyproject.toml to reflect the new project name "immich-py". - Updated README.md to point to the new repository and adjusted the badge URLs accordingly. - Modified user agent and device ID in sdk.py and upload.py to use "immich-py". --- README.md | 6 +++--- immich/_internal/upload.py | 2 +- immich/sdk.py | 2 +- pyproject.toml | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c1e1ac6..8769119 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

Unofficial Python client for the Immich API.

- Supported Immich version + Supported Immich version Package version @@ -14,8 +14,8 @@ PyPI - Downloads - GitHub Actions Workflow Status - + GitHub Actions Workflow Status + GitHub Repository diff --git a/immich/_internal/upload.py b/immich/_internal/upload.py index aa38724..1ef4017 100644 --- a/immich/_internal/upload.py +++ b/immich/_internal/upload.py @@ -305,7 +305,7 @@ async def upload_file( response = await assets_api.upload_asset_with_http_info( asset_data=asset_data, device_asset_id=f"{filepath.name}-{stats.st_size}".replace(" ", ""), - device_id="immich-python-client", + device_id="immich-py", file_created_at=file_created_at, file_modified_at=file_modified_at, sidecar_data=sidecar_data, diff --git a/immich/sdk.py b/immich/sdk.py index add5183..6d59aff 100644 --- a/immich/sdk.py +++ b/immich/sdk.py @@ -308,7 +308,7 @@ def __init__( base_url=base_url, ) self.base_client = ApiClient(configuration=self.config) - self.base_client.user_agent = "immich-python-client" + self.base_client.user_agent = "immich-py" # Allow caller to inject a pre-configured aiohttp session. if http_client is not None: diff --git a/pyproject.toml b/pyproject.toml index f8db030..c4f3319 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,8 +38,8 @@ dependencies = [ build = ["uv==0.9.21"] [project.urls] -Repository = "https://github.com/timonrieger/immich-python-client" -Changelog = "https://github.com/timonrieger/immich-python-client/releases" +Repository = "https://github.com/timonrieger/immich-py" +Changelog = "https://github.com/timonrieger/immich-py/releases" [build-system] requires = ["uv_build==0.9.21"] From fda89406981f34674edf1cc66c27b5f62683bafb Mon Sep 17 00:00:00 2001 From: timonrieger Date: Wed, 14 Jan 2026 20:36:29 +0100 Subject: [PATCH 2/3] update readme title --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8769119..ced6523 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ - -

Immich API Client

-

Unofficial Python client for the Immich API.

+

immich-py

+

Unofficial Python SDK & CLI for the Immich API.

Supported Immich version From 0c86d7cfb83879be294e504e3582c31d245fcb75 Mon Sep 17 00:00:00 2001 From: timonrieger Date: Thu, 15 Jan 2026 00:27:34 +0100 Subject: [PATCH 3/3] docs: update CONTRIBUTING.md to clarify contribution guidelines - Revised the instructions for installing mise and running CI checks. - Specified the directories containing auto-generated code that must not be modified. - Enhanced issue reporting guidelines with links to the relevant repositories. --- CONTRIBUTING.md | 27 +++++---------------------- 1 file changed, 5 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a19bde6..7d24128 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Pull requests are welcome! However, **modifications to auto-generated code will Before submitting a pull request, please ensure: -1. Install [mise](https://mise.jdx.dev) if you haven't already +1. Install [mise](https://mise.jdx.dev) 2. Run `mise run ci:check` to verify all checks pass 3. To see all available tasks, run `mise tasks ls` @@ -18,30 +18,13 @@ Before submitting a pull request, please ensure: The following directories contain auto-generated code and **must not be modified**: -- `immich/client/` - All files in this directory are auto-generated from the Immich OpenAPI specification -- Any other auto-generated files - -The generated client is updated by automation: - -- Generate client from the upstream Immich release -- Commit to `main` via an automation PR -- Tag + release to PyPI - -### What can be contributed - -You can contribute to: - -- Custom wrapper functions in `immich/client_wrapper/` -- Internal functions in `immich/_internal/` -- SDK-level code in `immich/sdk.py` -- Tests in `tests/` -- Documentation improvements -- Build and development tooling +- `immich/client/` - Auto-generated client +- `immich/cli/commands/` - Auto-generated CLI commands ## Where to report issues -- **Immich API/spec problems** (missing/incorrect endpoints, schema issues, breaking API changes): open an issue in the upstream Immich repository. -- **Generation issues** (bad codegen output, typing problems introduced by generation, workflow automation problems): open an issue here. +- **Immich API/spec problems** (missing/incorrect endpoints, schema issues, breaking API changes): open an issue in the [upstream Immich repository](https://github.com/immich-app/immich/issues). +- **Generation issues** (bad codegen output, typing problems introduced by generation, workflow automation problems): open an issue [here](https://github.com/timonrieger/immich-py/issues). When reporting, include: