Giter VIP home page Giter VIP logo

profilarr's Introduction

Profilarr

Profilarr is a Python-based tool designed to add import/export/sync functionality to the *arr suite. It offers a user-friendly way to export existing custom formats / profiles, import new ones or sync a master instance of Radarr / Sonarr with extras.

⚠️ 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. (Seriously, do it. Even I've lost data to this tool because I forgot to back up my configs.)

🛠️ Installation

Prerequisites

  • Python 3.x installed. You can download it from python.org.
  • Radarr / Sonarr

📦 Dependencies

  • requests (Install using pip install requests)

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.
  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.

Importing

  1. Run python importarr.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.

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.

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.

🌟 Upcoming Features

  • Lidarr Support: Expand functionality to include Lidarr, allowing users to manage music quality profiles and custom formats.
  • 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.

TRASH Guides

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/

profilarr's People

Contributors

santiagosayshey avatar pkeech avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.