git-sync/profilarr
1
0
Fork 0
mirror of https://github.com/Dictionarry-Hub/profilarr.git synced 2026-01-22 10:51:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

v0.1.3.1

Browse Source 
- updated readme to reflect changes in usage
This commit is contained in:
santiagosayshey
2024-01-19 19:15:38 +10:30
parent d6e8094700
commit e9c26f67dd
1 changed files with 43 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -1,13 +1,12 @@
# Profilarr
# Profilarr!
Profilarr is a Python-based tool that enables synchronization of custom formats and quality profiles in Radarr / Sonarr. It's designed to aid users in exporting / importing custom formats & quality profiles seamlessly.
Companion tool to Dictionarry to mass import custom formats / profiles quickly.
Profilarr is a Python-based tool designed to add import / export functionality to the \*arr suite. It allows custom formats and quality profiles. It offers a user-friendly way to export and import custom formats and quality profiles between Radarr and Sonarr installations.
## ⚠️ Before Continuing
- **This tool will overwrite any custom formats in your \*arr installation that have the same name.**
- **Custom Formats MUST be imported before syncing any premade profile.**
- **Always back up your Radarr and Sonarr configurations before using Profilarr to avoid unintended data loss.**
## 🛠️ Installation
@@ -16,34 +15,50 @@ Companion tool to Dictionarry to mass import custom formats / profiles quickly.
- Python 3.x installed. You can download it from [python.org](https://www.python.org/downloads/).
- Radarr / Sonarr
### Steps
1. Download the Profilarr zip file from the release section.
2. Extract its contents into a folder.
3. Open either of the `import.py` files in a text editor of your choice.
- Add your Radarr / Sonarr API key to the designated section.
- Modify the Base URL if needed
4. Save the changes and close the text editor.
## 🚀 Usage
1. Open a terminal or command prompt.
2. Navigate to the directory where you extracted Profilarr.
3. Run the command `python import_custom_formats.py` to import the necessary custom formats.
4. Run the command `python import_quality_profiles.py` and follow the prompts to choose and import your desired profile.
## 📦 Dependencies
### 📦 Dependencies
- `requests` (Install using `pip install requests`)
## ⚙️ Configuration
### Initial Setup
### API Key and Base URL
1. Download the 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.
- Sync coming soon (so don't worry about it for now)
4. Save the changes.
- Your API Keys and Base URL can be configured in the `import.py` file.
- The Base URL should be in the format `http://localhost:7878 / 8989` unless you have a different host or port.
## 🚀 Usage
### Radarr into Sonarr
### Exporting
- Custom formats can be freely imported and exported from sonarr to radarr.
- Profiles cannot be imported from radarr to sonarr or vice versa. This is because some of the quality source names are different in each program. To get around this issue, export an already made profile from radarr / sonarr, replace the quality items from said profile into your profile of choice and then import it. You can then adjust the quality sources inside the app as you desire.
1. Run `python export.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.
### Importing
1. Run `python import.py` in your command line interface.
2. Follow the on-screen prompts to select the app and the data you want to import.
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.
### Radarr and Sonarr Compatibility
- Custom formats can be imported and exported between Radarr and Sonarr.
- Quality profiles are not directly interchangeable between Radarr and Sonarr due to differences in quality source names. To work around this, export a profile from one application, modify it as needed, and then import it into the other application. Further adjustments can then be made within the app.
Certainly! Here's the "Upcoming Features" section for the README:
## 🌟 Upcoming Features
- **Lidarr Support:** Expand functionality to include Lidarr, allowing users to manage music quality profiles and custom formats.
- **Syncing Multiple Instances:** Simplify the management of multiple Radarr/Sonarr instances. This feature aims to enable seamless syncing of profiles and formats across different installations.
- **User Interface (UI):** Development of a graphical user interface (GUI) for easier and more intuitive interaction with Profilarr. This UI will cater to users who prefer graphical over command-line interactions.
- **Automatic Updates:** Implement an auto-update mechanism for Profilarr, ensuring users always have access to the latest features, improvements, and bug fixes without manual intervention.