feat: add experimental support for readarr

* this commit is not functional because the API of readarr is different then the other current available *arr projects (v1 vs v3 endpoints)
raydak-labs · Nov 17, 2024 · b1fa47b · b1fa47b
1 parent 0df7d42
commit b1fa47b
Show file tree

Hide file tree

Showing 22 changed files with 6,801 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,13 @@ Other projects:
   - Provide CFs directly in config (Convert JSON with https://www.bairesdev.com/tools/json2yaml/)
   - Merge order is `TrashGuide -> LocalFiles -> CFs in Config`
 
+### Supported \*arr Applications
+
+- Radarr
+- Sonarr
+- Whisparr (experimental)
+- Readarr (experimental)
+
 ## Configuration
 
 Full documentation can be found here: https://configarr.raydak.de

diff --git a/docs/docs/configuration/config-file.md b/docs/docs/configuration/config-file.md
@@ -162,32 +162,10 @@ radarr:
           min_format_score: 200
 
 # experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
-whisparr:
-  instance1: # Instance name (can be any unique identifier)
-    base_url: http://whisparr:6969 # instance URL
-    api_key: !secret WHISPARR_API_KEY # Reference to API key in secrets.yml
-
-    quality_definition:
-      type: movies # TODO: not checked yet
-
-    include:
-      # only custom defined templates available
-      - template: whisparr
-
-    custom_formats: # Custom format assignments
-      - trash_ids:
-          - example-in-config-cf
-        assign_scores_to:
-          - name: ExampleProfile
-            score: 1000
+whisparr: {}
 
-    quality_profiles:
-      # TODO: language not correctly mapped
-      - name: ExampleProfile
-        upgrade:
-          until_score: 200
-          # Not supported in whisparr
-          #min_format_score: 200
+# experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
+readarr: {}
 ```
 
 ### secrets.yml

diff --git a/docs/docs/configuration/experimental-support.md b/docs/docs/configuration/experimental-support.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 title: Experimental Support
 description: "Experimental and testing support for other *Arr tools"
-keywords: [configarr configuration, yaml config, custom formats, expermintal, whisparr]
+keywords: [configarr configuration, yaml config, custom formats, expermintal, whisparr, readarr]
 ---
 
 # Experimental support
@@ -29,3 +29,124 @@ Following things are currently not supported or tested:
   ```
 - initial language of quality profiles is not correct -> `0`
 - no available presets because nothings provided in trash guide or recyclarr -> needs to be done manually with local templates and custom formats
+
+### Configuration File
+
+Check [configuration file reference](/docs/configuration/config-file#custom-format-definitions) for more information.
+
+Specifics for Whisparr:
+
+```yaml title="config.yml"
+localCustomFormatsPath: /app/cfs
+localConfigTemplatesPath: /app/templates
+
+customFormatDefinitions:
+  - trash_id: example-in-config-cf
+    trash_scores:
+      default: -10000
+    trash_description: "Language: German Only"
+    name: "Language: Not German"
+    includeCustomFormatWhenRenaming: false
+    specifications:
+      - name: Not German Language
+        implementation: LanguageSpecification
+        negate: true
+        required: false
+        fields:
+          value: 4
+
+# experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
+whisparr:
+  instance1: # Instance name (can be any unique identifier)
+    base_url: http://whisparr:6969 # instance URL
+    api_key: !secret WHISPARR_API_KEY # Reference to API key in secrets.yml
+
+    quality_definition:
+      type: movies # TODO: not checked yet
+
+    include:
+      # only custom defined templates available
+      - template: whisparr
+
+    custom_formats: # Custom format assignments
+      - trash_ids:
+          - example-in-config-cf
+        assign_scores_to:
+          - name: ExampleProfile
+            score: 1000
+
+    quality_profiles:
+      # TODO: language not correctly mapped
+      - name: ExampleProfile
+        upgrade:
+          until_score: 200
+          # Not supported in whisparr
+          #min_format_score: 200
+```
+
+## Readarr v1
+
+Experimental support for Readarr was added with [v1.5.0](https://github.com/raydak-labs/configarr/releases/tag/v1.4.0).
+
+Configuration is mostly equal to the Sonarr or Radarr.
+
+Following things are currently not supported or tested:
+
+- quality definition preset is not evaluated
+  ```yaml
+  quality_definition:
+    type: movies # not checked yet
+  ```
+- metadata profiles are not supported. This is a specific thing to readarr and requires custom implementation and breaking out of some abstraction layer we have in the code
+- no available presets because nothings provided in trash guide or recyclarr -> needs to be done manually with local templates and custom formats
+
+### Configuration File
+
+Check [configuration file reference](/docs/configuration/config-file#custom-format-definitions) for more information.
+
+Specifics for Whisparr:
+
+```yaml title="config.yml"
+localCustomFormatsPath: /app/cfs
+localConfigTemplatesPath: /app/templates
+
+customFormatDefinitions:
+  - trash_id: example-release-title-cf
+    trash_scores:
+      default: 0
+    name: ExampleReleaseTitleCF
+    includeCustomFormatWhenRenaming: false
+    specifications:
+      - name: Preferred Words
+        implementation: ReleaseTitleSpecification
+        negate: false
+        required: false
+        fields:
+          value: "\\b(SPARKS|Framestor)\\b"
+
+# experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
+readarr:
+  instance1: # Instance name (can be any unique identifier)
+    base_url: http://readarr:8787 # instance URL
+    api_key: !secret READARR_API_KEY # Reference to API key in secrets.yml
+
+    # not supported
+    # quality_definition:
+    #   type: movies # Quality definition type
+
+    include:
+      # only custom defined templates available
+      - template: readarr
+
+    custom_formats: # Custom format assignments
+      - trash_ids:
+          - example-release-title-cf
+        assign_scores_to:
+          - name: ExampleProfile
+            score: 1000
+
+    quality_profiles:
+      - name: ExampleProfile
+        upgrade:
+          until_score: 200
+```
diff --git a/examples/full/config/config.yml b/examples/full/config/config.yml
@@ -17,6 +17,18 @@ customFormatDefinitions:
         required: false
         fields:
           value: 4
+  - trash_id: example-release-title-cf
+    trash_scores:
+      default: 0
+    name: ExampleReleaseTitleCF
+    includeCustomFormatWhenRenaming: false
+    specifications:
+      - name: Preferred Words
+        implementation: ReleaseTitleSpecification
+        negate: false
+        required: false
+        fields:
+          value: "\\b(SPARKS|Framestor)\\b"
 
 sonarr:
   instance1:
@@ -107,3 +119,31 @@ whisparr:
           until_score: 200
           # Not supported in whisparr
           #min_format_score: 200
+
+readarr:
+  instance1: # Instance name (can be any unique identifier)
+    base_url: http://readarr:8787 # instance URL
+    api_key: !secret READARR_API_KEY # Reference to API key in secrets.yml
+
+    # not supported
+    # quality_definition:
+    #   type: movies # Quality definition type
+
+    include:
+      # only custom defined templates available
+      - template: readarr
+
+    custom_formats: # Custom format assignments
+      - trash_ids:
+          - example-release-title-cf
+        assign_scores_to:
+          - name: ExampleProfile
+            score: 1000
+
+    quality_profiles:
+      # TODO: language not correctly mapped
+      - name: ExampleProfile
+        upgrade:
+          until_score: 200
+          # Not supported in whisparr
+          #min_format_score: 200
diff --git a/examples/full/config/secrets.yml b/examples/full/config/secrets.yml
@@ -1,3 +1,4 @@
 SONARR_API_KEY: 5e792b7e0fe14f58b8e92bf0902d4a44
 RADARR_API_KEY: 0daa3a2b940f4e08bac991e9a30e9e12
 WHISPARR_API_KEY: 2ebd18db81e14c2d98d06ef4b865aaa8
+READARR_API_KEY: e001718ba38a424d8aae7cb391b5d27a
diff --git a/examples/full/docker-compose.yml b/examples/full/docker-compose.yml
@@ -29,6 +29,7 @@ services:
       - 6501:7878
     restart: unless-stopped
 
+  # experimental
   whisparr:
     image: ghcr.io/hotio/whisparr:v3-3.0.0.695
     networks:
@@ -45,6 +46,22 @@ services:
       - ${PWD}/whisparr.xml:/config/config.xml:rw
     restart: unless-stopped
 
+  # experimental
+  readarr:
+    image: lscr.io/linuxserver/readarr:develop-0.4.3.2665-ls130
+    networks:
+      - configarr-full
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Etc/UTC
+    volumes:
+      - readarr:/config
+      - ${PWD}/readarr.xml:/config/config.xml:rw
+    ports:
+      - 6503:8787
+    restart: unless-stopped
+
 networks:
   configarr-full:
     name: configarr-full
@@ -53,3 +70,4 @@ volumes:
   sonarr:
   radarr:
   whisparr:
+  readarr:
diff --git a/examples/full/readarr.xml b/examples/full/readarr.xml
@@ -0,0 +1,17 @@
+<Config>
+  <BindAddress>*</BindAddress>
+  <Port>8787</Port>
+  <SslPort>6868</SslPort>
+  <EnableSsl>False</EnableSsl>
+  <LaunchBrowser>True</LaunchBrowser>
+  <ApiKey>e001718ba38a424d8aae7cb391b5d27a</ApiKey>
+  <AuthenticationMethod>Basic</AuthenticationMethod>
+  <AuthenticationRequired>DisabledForLocalAddresses</AuthenticationRequired>
+  <Branch>develop</Branch>
+  <LogLevel>debug</LogLevel>
+  <SslCertPath></SslCertPath>
+  <SslCertPassword></SslCertPassword>
+  <UrlBase></UrlBase>
+  <InstanceName>Readarr</InstanceName>
+  <UpdateMechanism>Docker</UpdateMechanism>
+</Config>
diff --git a/examples/full/templates/readarr.yml b/examples/full/templates/readarr.yml
@@ -0,0 +1,13 @@
+quality_profiles:
+  - name: ExampleProfile
+    reset_unmatched_scores:
+      enabled: true
+    upgrade:
+      allowed: true
+      until_quality: MOBI
+      until_score: 1000
+    min_format_score: 5
+    quality_sort: top
+    qualities:
+      - name: EPUB
+      - name: MOBI
diff --git a/generate-api.ts b/generate-api.ts
@@ -6,6 +6,7 @@ const PATH_TO_OUTPUT_DIR = path.resolve(process.cwd(), "./src/__generated__");
 const PATH_SONARR_DIR = path.resolve(PATH_TO_OUTPUT_DIR, "sonarr");
 const PATH_RADARR_DIR = path.resolve(PATH_TO_OUTPUT_DIR, "radarr");
 const PATH_WHISPARR_DIR = path.resolve(PATH_TO_OUTPUT_DIR, "whisparr");
+const PATH_READARR_DIR = path.resolve(PATH_TO_OUTPUT_DIR, "readarr");
 
 const main = async () => {
   await generateApi({
@@ -41,9 +42,21 @@ const main = async () => {
     },
   });
 
+  await generateApi({
+    output: PATH_READARR_DIR,
+    url: "https://raw.githubusercontent.com/Readarr/Readarr/develop/src/Readarr.Api.V1/openapi.json",
+    modular: true,
+    singleHttpClient: true,
+    // @ts-ignore little hack to have one single client (we are deleting the weird created file for the http-client)
+    fileNames: {
+      httpClient: "../ky-client",
+    },
+  });
+
   unlinkSync(path.resolve(PATH_SONARR_DIR, "..ts"));
   unlinkSync(path.resolve(PATH_RADARR_DIR, "..ts"));
   unlinkSync(path.resolve(PATH_WHISPARR_DIR, "..ts"));
+  unlinkSync(path.resolve(PATH_READARR_DIR, "..ts"));
 };
 
 main();