Remove Overlay label on poster upload (#29)

Buried-In-Code · web-flow · commit e5c68aeb00d2 · 2025-02-10T13:29:25.000+13:00
* Add kometa integration

* Fix pre-commit mdformat of issue_templates
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,6 +14,7 @@ repos:
         args:
           - --number
           - --wrap=keep
+        exclude: ".github\/ISSUE_TEMPLATE\/.*.md"
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
diff --git a/README.md b/README.md
@@ -69,14 +69,14 @@ Pulls Posters, Backdrops and Title Cards.
 
 ## Notes
 
- - When running a sync/show/collection/movie it will keep downloading sets until all the needed posters are found.
-    - **Show:** Poster and Backdrop
-    - **Season:** Poster
-    - **Episode:** Title Card
-    - **Collection:** Poster and Backdrop
-    - **Movie:** Poster and Backdrop
- - To enable support for Collections in Plex, each Collection needs to have a label with its tmdb-id, in the format of `tmdb-<number>`\
-   If using Kometa, refer to [this comment](https://github.com/Buried-In-Code/Mediux-Posters/issues/12#issuecomment-2622002859) to have Kometa add these labels.
+- When running a sync/show/collection/movie it will keep downloading sets until all the needed posters are found.
+  - **Show:** Poster and Backdrop
+  - **Season:** Poster
+  - **Episode:** Title Card
+  - **Collection:** Poster and Backdrop
+  - **Movie:** Poster and Backdrop
+- To enable support for Collections in Plex, each Collection needs to have a label with its tmdb-id, in the format of `tmdb-<number>`\
+  If using Kometa, refer to [this comment](https://github.com/Buried-In-Code/Mediux-Posters/issues/12#issuecomment-2622002859) to have Kometa add these labels.
 
 ## Settings
 
@@ -87,6 +87,7 @@ File will be created on first run.
 
 ```toml
 exclude_usernames = []
+kometa_integration = false
 only_priority_usernames = false
 priority_usernames = []
 
@@ -105,6 +106,10 @@ token = "<Token>"
 
   A list of usernames whose sets should be ignored when running a sync.
 
+- `kometa_integration`
+
+  If enabled, will remove the `Overlay` label from any media Mediux-Posters uploads a poster/backdrop/title-card to.
+
 - `only_priority_usernames`
 
   A boolean flag that limits downloading sets to ones created by the users specified in `priority_usernames`.
diff --git a/mediux_posters/__main__.py b/mediux_posters/__main__.py
@@ -90,36 +90,37 @@ def filter_sets(
 
 def update_posters(
     mediux_data: dict,
-    obj: BaseShow | BaseMovie | BaseCollection,
+    obj: BaseShow | BaseCollection | BaseMovie,
     mediux: Mediux,
     service: BaseService,
+    kometa_integration: bool,
     abort_on_unknown: bool = False,
     debug: bool = False,
 ) -> None:
     if mediux_data.get("show") and isinstance(obj, BaseShow):
         mediux.download_show_posters(data=mediux_data, show=obj)
-        service.upload_posters(obj=obj)
+        service.upload_posters(obj=obj, kometa_integration=kometa_integration)
         for season in obj.seasons:
-            service.upload_posters(obj=season)
+            service.upload_posters(obj=season, kometa_integration=kometa_integration)
             for episode in season.episodes:
-                service.upload_posters(obj=episode)
-    elif mediux_data.get("movie") and isinstance(obj, BaseMovie):
-        mediux.download_movie_posters(data=mediux_data, movie=obj)
-        service.upload_posters(obj=obj)
+                service.upload_posters(obj=episode, kometa_integration=kometa_integration)
     elif mediux_data.get("collection") and isinstance(obj, BaseCollection):
         mediux.download_collection_posters(data=mediux_data, collection=obj)
-        service.upload_posters(obj=obj)
+        service.upload_posters(obj=obj, kometa_integration=kometa_integration)
         for movie_data in mediux_data.get("collection", {}).get("movies", []):
             if movie := service.get_movie(tmdb_id=int(movie_data.get("id", -1))):
                 mediux.download_movie_posters(data=mediux_data, movie=movie)
-                service.upload_posters(obj=movie)
+                service.upload_posters(obj=movie, kometa_integration=kometa_integration)
             else:
                 LOGGER.warning(
                     "[%s] Unable to find '%s (%s)'",
                     type(service).__name__,
                     movie_data.get("title"),
                     (movie_data.get("release_date") or "0000")[:4],
                 )
+    elif mediux_data.get("movie") and isinstance(obj, BaseMovie):
+        mediux.download_movie_posters(data=mediux_data, movie=obj)
+        service.upload_posters(obj=obj, kometa_integration=kometa_integration)
     else:
         LOGGER.error("Unknown data set: %s", mediux_data)
         if debug:
@@ -223,7 +224,12 @@ def sync_posters(
                         set_data.get("user_created", {}).get("username"),
                     )
                     update_posters(
-                        mediux_data=set_data, obj=entry, mediux=mediux, service=service, debug=debug
+                        mediux_data=set_data,
+                        obj=entry,
+                        mediux=mediux,
+                        service=service,
+                        kometa_integration=settings.kometa_integration,
+                        debug=debug,
                     )
                     if entry.all_posters_uploaded:
                         break
@@ -323,7 +329,12 @@ def show_posters(
                     set_data.get("user_created", {}).get("username"),
                 )
                 update_posters(
-                    mediux_data=set_data, obj=obj, mediux=mediux, service=service, debug=debug
+                    mediux_data=set_data,
+                    obj=obj,
+                    mediux=mediux,
+                    service=service,
+                    kometa_integration=settings.kometa_integration,
+                    debug=debug,
                 )
                 if obj.all_posters_uploaded:
                     break
@@ -424,7 +435,12 @@ def collection_posters(
                     set_data.get("user_created", {}).get("username"),
                 )
                 update_posters(
-                    mediux_data=set_data, obj=obj, mediux=mediux, service=service, debug=debug
+                    mediux_data=set_data,
+                    obj=obj,
+                    mediux=mediux,
+                    service=service,
+                    kometa_integration=settings.kometa_integration,
+                    debug=debug,
                 )
                 if obj.all_posters_uploaded:
                     break
@@ -524,7 +540,12 @@ def movie_posters(
                     set_data.get("user_created", {}).get("username"),
                 )
                 update_posters(
-                    mediux_data=set_data, obj=obj, mediux=mediux, service=service, debug=debug
+                    mediux_data=set_data,
+                    obj=obj,
+                    mediux=mediux,
+                    service=service,
+                    kometa_integration=settings.kometa_integration,
+                    debug=debug,
                 )
                 if obj.all_posters_uploaded:
                     break
@@ -597,7 +618,7 @@ def set_posters(
             if tmdb_id:
                 tmdb_id = int(tmdb_id)
             with CONSOLE.status(
-                f"Searching {type(service).__name__} for '{set_data.get('set_name')} [tmdb-{tmdb_id}]'"
+                f"Searching {type(service).__name__} for '{set_data.get('set_name')} [{tmdb_id}]'"
             ):
                 obj = (
                     service.get_show(tmdb_id=tmdb_id)
@@ -643,6 +664,7 @@ def set_posters(
                 obj=obj,
                 mediux=mediux,
                 service=service,
+                kometa_integration=settings.kometa_integration,
                 abort_on_unknown=True,
                 debug=debug,
             )
diff --git a/mediux_posters/services/_base.py b/mediux_posters/services/_base.py
@@ -143,4 +143,4 @@ def list_movies(self, skip_libraries: list[str] | None = None) -> list[M]: ...
     def get_movie(self, tmdb_id: int) -> M | None: ...
 
     @abstractmethod
-    def upload_posters(self, obj: T | S | E | M | C) -> None: ...
+    def upload_posters(self, obj: T | S | E | M | C, kometa_integration: bool) -> None: ...
diff --git a/mediux_posters/services/jellyfin.py b/mediux_posters/services/jellyfin.py
@@ -234,7 +234,11 @@ def list_collections(self, skip_libraries: list[str] | None = None) -> list:  #
     def get_collection(self, tmdb_id: int) -> None:  # noqa: ARG002
         return None
 
-    def upload_posters(self, obj: Show | Season | Episode | Movie | None) -> None:
+    def upload_posters(
+        self,
+        obj: Show | Season | Episode | Movie | None,
+        kometa_integration: bool,  # noqa: ARG002
+    ) -> None:
         if isinstance(obj, Show | Movie):
             options = [
                 (obj.poster, "poster_uploaded", "Primary"),
diff --git a/mediux_posters/services/plex.py b/mediux_posters/services/plex.py
@@ -182,7 +182,9 @@ def list_collections(self, skip_libraries: list[str] | None = None) -> list[Coll
     def get_collection(self, tmdb_id: int) -> Collection | None:
         return self._search(library_type="collection", search_id=tmdb_id)
 
-    def upload_posters(self, obj: Show | Season | Episode | Movie | Collection) -> None:
+    def upload_posters(
+        self, obj: Show | Season | Episode | Movie | Collection, kometa_integration: bool
+    ) -> None:
         if isinstance(obj, Show | Movie | Collection):
             options = [
                 (obj.poster, "poster_uploaded", obj.plex.uploadPoster),
@@ -202,6 +204,8 @@ def upload_posters(self, obj: Show | Season | Episode | Movie | Collection) -> N
                 try:
                     func(filepath=str(image_file))
                     setattr(obj, field, True)
+                    if kometa_integration:
+                        obj.plex.removeLabel("Overlay").reload()
                 except (ConnectionError, HTTPError, ReadTimeout, BadRequest, NotFound) as err:
                     LOGGER.error(
                         "[Plex] Failed to upload %s: %s",
diff --git a/mediux_posters/settings.py b/mediux_posters/settings.py
@@ -53,6 +53,7 @@ class Settings(BaseModel):
     _file: ClassVar[Path] = get_config_root() / "settings.toml"
 
     exclude_usernames: list[str] = Field(default_factory=list)
+    kometa_integration: bool = False
     only_priority_usernames: bool = False
     priority_usernames: list[str] = Field(default_factory=list)
     jellyfin: Jellyfin = Jellyfin()
