Add prowlarr support

Author: hemantapkh

README.md

@@ -40,13 +40,7 @@ inside Telegram, in your language.
 
 # 🔌 Search Provider
 
-Torrent Hunt uses [Jackett](https://github.com/Jackett/Jackett) as its search
-provider. Every indexer you configure in Jackett becomes searchable from the
-bot.
-
-**Todo**
-
-- [ ] [Prowlarr](https://github.com/Prowlarr/Prowlarr) support
+Torrent Hunt supports [Jackett](https://github.com/Jackett/Jackett) and [Prowlarr](https://github.com/Prowlarr/Prowlarr) as its search providers. Every indexer you configure in them becomes searchable from the bot.
 
 # 🗣️ Languages
 

app.json

@@ -42,7 +42,7 @@
             "required": true
         },
         "TORRENT_PROVIDER": {
-            "description": "Torrent search backend (currently supported: jackett)",
+            "description": "Torrent search backend (currently supported: jackett, prowlarr)",
             "value": "jackett",
             "required": false
         },
@@ -56,6 +56,16 @@
             "value": "",
             "required": true
         },
+        "PROWLARR_URL": {
+            "description": "Base URL of the Prowlarr instance",
+            "value": "http://localhost:9696",
+            "required": false
+        },
+        "PROWLARR_API_KEY": {
+            "description": "API key of the Prowlarr instance",
+            "value": "",
+            "required": false
+        },
         "SENTRY_DSN": {
             "description": "Sentry.io token for error tracking",
             "value": "",

app/bot/helpers.py

@@ -126,7 +126,7 @@ async def load_sites() -> None:
     sources = await ctx.search.sources()
 
     ctx.sites = {
-        source_id: {"website": name} for source_id, name in sources.items()
+        source.id: {"website": source.name} for source in sources.items
     }
 
     logger.info(

app/config.py

@@ -7,6 +7,7 @@
 """
 
 from pathlib import Path
+from typing import Literal
 
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
@@ -36,12 +37,17 @@ class Settings(BaseSettings):
     cleanup_interval_minutes: float = 60
 
     # Torrent search provider
-    torrent_provider: str = "jackett"
+    torrent_provider: Literal["jackett", "prowlarr"] = "jackett"
     jackett_url: str = "http://localhost:9117"
     jackett_api_key: str = ""
     jackett_indexer: str = "all"
     jackett_timeout: float = 40
 
+    prowlarr_url: str = "http://localhost:9696"
+    prowlarr_api_key: str = ""
+    prowlarr_indexer: str = "all"
+    prowlarr_timeout: float = 40
+
     # Message to forward on start
     start_ads: bool = False
     start_ads_channel: str = ""

app/main.py

@@ -49,13 +49,26 @@
 
 logger.info("Initializing torrent search service")
 torrent_store = DatabaseTorrentStore(retention_days=settings.torrent_cache_days)
+provider_kwargs = {}
+if settings.torrent_provider == "prowlarr":
+    provider_kwargs = {
+        "base_url": settings.prowlarr_url,
+        "api_key": settings.prowlarr_api_key,
+        "indexer": settings.prowlarr_indexer,
+        "timeout": settings.prowlarr_timeout,
+    }
+else:
+    provider_kwargs = {
+        "base_url": settings.jackett_url,
+        "api_key": settings.jackett_api_key,
+        "indexer": settings.jackett_indexer,
+        "timeout": settings.jackett_timeout,
+    }
+
 ctx.search = SearchService(
     provider=create_provider(
         settings.torrent_provider,
-        base_url=settings.jackett_url,
-        api_key=settings.jackett_api_key,
-        indexer=settings.jackett_indexer,
-        timeout=settings.jackett_timeout,
+        **provider_kwargs
     ),
     store=torrent_store,
 )

app/search_engine/base.py

@@ -2,7 +2,7 @@
 
 from abc import ABC, abstractmethod
 
-from search_engine.models import SearchResults
+from search_engine.models import IndexerList, SearchResults
 
 
 class TorrentProvider(ABC):
@@ -31,14 +31,13 @@ async def search(
         Must not raise on backend failures: log and return empty results.
         """
 
-    async def sources(self) -> dict[str, str]:
+    async def sources(self) -> IndexerList:
         """Return the backend's individually searchable sources.
 
-        Maps a source id (usable as `search(source=...)`) to a display
-        name, e.g. Jackett/Prowlarr indexers. Backends without such a
-        concept return an empty dict.
+        Backends without such a concept return an empty list.
         """
-        return {}
+        return IndexerList()
 
     async def close(self) -> None:
         """Release any underlying resources (HTTP sessions etc.)."""
+

app/search_engine/models.py

@@ -56,3 +56,24 @@ def to_dict(self) -> dict[str, Any]:
             "page": self.page,
             "provider": self.provider,
         }
+
+
+@dataclass
+class Indexer:
+    """A search backend indexer/source."""
+
+    id: str
+    name: str
+
+    def to_dict(self) -> dict[str, Any]:
+        return asdict(self)
+
+
+@dataclass
+class IndexerList:
+    """A list of available indexers."""
+
+    items: list[Indexer] = field(default_factory=list)
+
+    def to_dict(self) -> dict[str, Any]:
+        return {"items": [item.to_dict() for item in self.items]}

app/search_engine/providers/__init__.py

@@ -8,9 +8,11 @@
 
 from search_engine.base import TorrentProvider
 from search_engine.providers.jackett import JackettProvider
+from search_engine.providers.prowlarr.provider import ProwlarrProvider
 
 PROVIDERS: dict[str, type[TorrentProvider]] = {
     JackettProvider.name: JackettProvider,
+    ProwlarrProvider.name: ProwlarrProvider,
 }
 
 

app/search_engine/providers/jackett/provider.py

@@ -8,7 +8,7 @@
 from structlog import get_logger
 
 from search_engine.base import TorrentProvider
-from search_engine.models import SearchResults
+from search_engine.models import Indexer, IndexerList, SearchResults
 from search_engine.providers.jackett.constants import CATEGORY_MAP, RESULTS_ENDPOINT
 from search_engine.providers.jackett.parser import parse_torrent
 from search_engine.transport import HttpProvider
@@ -69,7 +69,7 @@ async def search(
 
         return results
 
-    async def sources(self) -> dict[str, str]:
+    async def sources(self) -> IndexerList:
         # Jackett's indexer listing endpoint needs cookie auth, but an
         # empty-query search reports every configured indexer it queried
         url = self.base_url + RESULTS_ENDPOINT.format(indexer=self.indexer)
@@ -81,10 +81,12 @@ async def sources(self) -> dict[str, str]:
                 payload = await response.json()
         except Exception as err:
             logger.error("Jackett indexer listing failed", error=str(err))
-            return {}
-
-        return {
-            indexer["ID"]: indexer.get("Name") or indexer["ID"]
-            for indexer in payload.get("Indexers") or []
-            if indexer.get("ID")
-        }
+            return IndexerList()
+
+        return IndexerList(
+            items=[
+                Indexer(id=indexer["ID"], name=indexer.get("Name") or indexer["ID"])
+                for indexer in payload.get("Indexers") or []
+                if indexer.get("ID")
+            ]
+        )

app/search_engine/providers/prowlarr/__init__.py

@@ -0,0 +1 @@
+"""Prowlarr provider."""