v0.2.3

- changed from json to yaml for config - added export_path setting to set where exported files go : fixes #5 - exports now save to {export_path}/{app_type}/{app_name} - can choose which instance to manually import to - sync automatically chooses correct custom formats / quality profiles for the app type - updated readme with usage examples - added install requirements
Dictionarry-Hub · Jan 27, 2024 · 4834cfd · 4834cfd
1 parent c39d477
commit 4834cfd
Show file tree

Hide file tree

Showing 7 changed files with 396 additions and 169 deletions.
diff --git a/README.md b/README.md
@@ -17,28 +17,76 @@ Profilarr is a Python-based tool designed to add import/export/sync functionalit
 
 ### 📦 Dependencies
 
-- `requests` (Install using `pip install requests`)
+- run `pip install -r requirements.txt` to install dependencies.
 
 ### Initial Setup
 
 1. Download the latest Profilarr package from the release section.
 2. Extract its contents into a folder.
-3. Open the `config.json` file in a text editor.
-   - Add your Radarr / Sonarr API key and modify the base URL as necessary.
-   - If importing / exporting, only change the master installation's API key and base URL.
-   - If syncing, add the API keys and base URLs of all instances you want to sync.
-   - The master install will be the one that all other instances sync to.
+3. Open the `config.yml` file in a text editor.
+   - Add the URL and API key to the master instances of Radarr / Sonarr.
+   - If syncing, add the URL, API key and a name to each extra instance of Radarr / Sonarr.
+   - If exporting, adjust the `export_path` to your desired export location.
 4. Save the changes.
 
 ## 🚀 Usage
 
 ### Exporting
 
 1. Run `python exportarr.py` in your command line interface.
-2. Follow the on-screen prompts to select the app (Radarr or Sonarr) and the data (Custom Formats or Quality Profiles) you want to export.
-3. Exported data will be saved in respective directories within the tool's folder.
-- Please be careful when running this tool, it will OVERWRITE the given custom formats file and you'll need to download it again if you want to import the quality profiles.
-- In future, there will be a config option to set where the files export to.
+2. Choose the instance you want to export from.
+3. Choose the data you want to export.
+4. The data will be exported to `exports/{instance_type}/{instance_name}/{data_type}`.
+
+#### Example
+
+```bash
+PS Z:\Profilarr> py exportarr.py
+Available sources to export from:
+1. Sonarr [Master]
+2. Radarr [Master]
+3. Sonarr [4k-sonarr]
+4. Radarr [4k-radarr]
+Enter the number of the app to export from: 2
+
+Choose what to export:
+1. Custom Formats
+2. Quality Profiles
+3. Both
+Enter your choice (1/2/3): 3
+
+Attempting to access Radarr at http://localhost:7878
+Found 131 custom formats.
+ - D-Z0N3
+ - DON
+ - EbP
+ - Geek
+ - TayTo
+ - ZQ
+ - VietHD
+ - CtrlHD
+ - HiFi
+ - FoRM
+... and 121 more.
+Saved to './exports\radarr\master\custom_formats\Custom Formats (Radarr).json'
+
+Attempting to access Radarr at http://localhost:7878
+Found 13 quality profiles.
+ - 1080p Optimal
+ - 2160p Optimal
+ - 1080p Balanced
+ - 1080p Transparent
+ - 1080p Transparent (Double Grab)
+ - 1080p Transparent (Single Grab)
+ - 1080p Balanced (Single Grab)
+ - 1080p h265 Balanced
+ - 1080p h265 Balanced (Single Grab)
+ - 1080p x265 HDR Transparent
+... and 3 more.
+Saved to 'exports\radarr\master\profiles'
+
+PS Z:\Profilarr>
+```
 
 ### Importing
 
@@ -47,16 +95,130 @@ Profilarr is a Python-based tool designed to add import/export/sync functionalit
 3. Choose the specific file for Custom Formats or select a profile for Quality Profiles.
 4. The data will be imported to your selected Radarr or Sonarr installation.
 
+#### Example
+
+```bash
+PS Z:\Profilarr> py importarr.py
+Available instances to import to:
+1. Sonarr [Master]
+2. Radarr [Master]
+3. Sonarr [4k-sonarr]
+4. Radarr [4k-radarr]
+Enter the number of the instance to import to: 4
+
+
+Choose what to import:
+1. Custom Formats
+2. Quality Profiles
+Enter your choice (1/2): 2
+
+Available files:
+1. 1080p Balanced (Radarr).json
+2. 1080p Balanced (Single Grab) (Radarr).json
+3. 1080p h265 Balanced (Radarr).json
+4. 1080p h265 Balanced (Single Grab) (Radarr).json
+5. 1080p Optimal (Radarr).json
+6. 1080p Optimal (Single Grab) (Radarr).json
+7. 1080p Transparent (Double Grab) (Radarr).json
+8. 1080p Transparent (Radarr).json
+9. 1080p Transparent (Single Grab) (Radarr).json
+10. 2160p Optimal (Radarr).json
+11. 2160p Optimal (Single Grab) (Radarr).json
+Select a file to import (or 'all' for all files): all
+
+Successfully added Quality Profile 1080p Balanced
+Successfully added Quality Profile 1080p Balanced (Single Grab)
+Successfully added Quality Profile 1080p h265 Balanced
+Successfully added Quality Profile 1080p h265 Balanced (Single Grab)
+Successfully added Quality Profile 1080p Optimal
+Successfully added Quality Profile 1080p Optimal (Single Grab)
+Successfully added Quality Profile 1080p Transparent (Double Grab)
+Successfully added Quality Profile 1080p Transparent
+Successfully added Quality Profile 1080p Transparent (Single Grab)
+Successfully added Quality Profile 2160p Optimal
+Successfully added Quality Profile 2160p Optimal (Single Grab)
+PS Z:\Profilarr>
+```
+
 ### Syncing
 
 1. Run `python syncarr.py` in your command line interface.
 2. The script will automatically export data from the master instance and import it to all other instances specified in `config.json`.
 3. This feature is designed to manage multiple Radarr/Sonarr instances, syncing profiles and formats seamlessly.
 
+#### Example
+
+```bash
+PS Z:\Profilarr> py syncarr.py
+Select the app you want to sync:
+1. Radarr
+2. Sonarr
+Enter your choice (1 or 2): 2
+Attempting to access Sonarr at http://localhost:8989
+Found 135 custom formats.
+ - D-Z0N3
+ - DON
+ - EbP
+ - Geek
+ - TayTo
+ - ZQ
+ - VietHD
+ - CtrlHD
+ - HiFi
+ - FoRM
+... and 125 more.
+Saved to './temp_directory/custom_formats\Custom Formats (Sonarr).json'
+
+Attempting to access Sonarr at http://localhost:8989
+Found 11 quality profiles.
+ - 1080p Transparent
+ - 2160p Optimal
+ - 1080p Transparent (Single Grab)
+ - 1080p Transparent (Double Grab)
+ - 1080p Balanced
+ - 1080p Balanced (Single Grab)
+ - 1080p h265 Balanced
+ - 1080p h265 Balanced (Single Grab)
+ - 1080p Optimal
+ - 1080p Optimal (Single Grab)
+... and 1 more.
+Saved to 'temp_directory\quality_profiles'
+
+Importing to instance: 4k-sonarr
+Adding custom format 'D-Z0N3': SUCCESS
+Adding custom format 'DON': SUCCESS
+Adding custom format 'EbP': SUCCESS
+Adding custom format 'Geek': SUCCESS
+Adding custom format 'TayTo': SUCCESS
+Adding custom format 'ZQ': SUCCESS
+Adding custom format 'VietHD': SUCCESS
+Adding custom format 'CtrlHD': SUCCESS
+Adding custom format 'HiFi': SUCCESS
+... and 125 more.
+
+Successfully added 135 custom formats, updated 0 custom formats.
+Successfully added Quality Profile 1080p Balanced (Single Grab)
+Successfully added Quality Profile 1080p Balanced
+Successfully added Quality Profile 1080p h265 Balanced
+Successfully added Quality Profile 1080p h265 Balanced (Single Grab)
+Successfully added Quality Profile 1080p Optimal (Single Grab)
+Successfully added Quality Profile 1080p Optimal
+Successfully added Quality Profile 1080p Transparent (Double Grab)
+Successfully added Quality Profile 1080p Transparent (Single Grab)
+Successfully added Quality Profile 1080p Transparent
+Successfully added Quality Profile 2160p Optimal (Single Grab)
+Successfully added Quality Profile 2160p Optimal
+Deleted temporary directory: ./temp_directory
+PS Z:\Profilarr>
+```
+
 ### Radarr and Sonarr Compatibility
 
-- Custom formats _can_ be imported and exported between Radarr and Sonarr (but might not work as expected).
-- Quality profiles are not directly interchangeable between Radarr and Sonarr due to differences in quality source names. If you want to use the same profile in both apps, you will need to manually edit the profile's quality source names before importing it.
+- You are only able to import / sync files to the app that is included in the file name (e.g. `Radarr` or `Sonarr`).
+- It is possible to manually rename the files to import them to the other app, but this is not recommended.
+  - Custom Formats will succesfully import, but will require manual editing to work with the other app, i.e. you must adjust the quality sources to match the other app's naming scheme.
+  - Quality Profiles will not import at all, as they are not compatible with the other app. It is possible to import them manually by editing the json directly, but this is not recommended.
+  - In future, I may add a feature to automatically convert profiles between the two apps, but this is not currently a priority.
 
 ## 🌟 Upcoming Features
 
@@ -69,3 +231,7 @@ Profilarr is a Python-based tool designed to add import/export/sync functionalit
 Some custom formats found here have been interated on from the trash guides. Credit for these goes entirely to trash, and can be found on their site here. It is not my intention to steal their work, but rather to build on it and make it more accessible to the average user through my quality profiles. Please check out their site for more information on their work.
 
 https://trash-guides.info/
+
+```
+
+```
diff --git a/config.json b/config.json
diff --git a/config.yml b/config.yml
@@ -0,0 +1,20 @@
+instances:
+  master:
+    sonarr:
+      base_url: "http://localhost:8989"
+      api_key: "cebbd35f27554964bc5203b19ec58673"
+    radarr:
+      base_url: "http://localhost:7878"
+      api_key: "611c1454f0034196bdbdb4c2c2f5f859"
+  extras:
+    sonarr:
+      - name: "4k-sonarr"
+        base_url: "http://localhost:8998"
+        api_key: "8b22f808956f4036ac01ccd5a2e9658f"
+    radarr:
+      - name: "4k-radarr"
+        base_url: "http://localhost:7887"
+        api_key: "a60e8976b6804462b70578d87145ba59"
+
+settings:
+  export_path: "./exports"