Skip to content

Commit

Permalink
v0.2.4
Browse files Browse the repository at this point in the history
## Features
- Implemented #12 
- Enhanced message formatting and user prompts for deletions.

## Additions
- ETHEL SCENE release group added.
- FLiGHTS group to missing HDR10.
- Overhauled h265 custom formats and added new h265 4k format.
- MAX WEB source added to custom formats.

## Improvements
- Script to generate initial config file.
- Removed tracking of config.yml for security.
- Updated README for install process and new delete feature.
  • Loading branch information
santiagosayshey authored Feb 3, 2024
1 parent 2c764f9 commit 2e5cabe
Show file tree
Hide file tree
Showing 7 changed files with 1,316 additions and 22 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,7 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

config.yml

exports/
70 changes: 68 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ Profilarr is a Python-based tool designed to add import/export/sync functionalit

1. Download the latest Profilarr package from the release section.
2. Extract its contents into a folder.
3. Open the `config.yml` file in a text editor.
3. Run `python setup.py` in your command line interface to generate a config file.
- This will create a `config.yml` file in the same directory as `setup.py`.
4. 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.
5. Save the changes.

## 🚀 Usage

Expand Down Expand Up @@ -250,6 +252,66 @@ Deleted temporary directory: ./temp_directory
PS Z:\Profilarr>
```

### Deleting

1. Run `python deletarr.py` in your command line interface.
2. Select the instance from which you wish to delete data.
3. Choose between deleting Custom Formats or Quality Profiles.
4. Select specific items by typing their numbers separated by commas, or type 'all' to delete everything.

#### Example: Deleting Custom Formats

```plaintext
PS Z:\Profilarr> python deletarr.py
Available instances to delete from:
1. Sonarr [Master]
2. Radarr [Master]
Enter the number of the instance to delete from: 2
Choose what to delete:
1. Custom Formats
2. Quality Profiles
Enter your choice (1/2): 1
Deleting selected custom formats...
Available items:
1. UHDBits
2. Dolby Vision w/out Fallback
...
132. h265 (4k)
133. MAX
Your choice: all
Deleting custom format 'UHDBits': SUCCESS
...
Deleting custom format 'MAX': SUCCESS
```

#### Example: Deleting Quality Profiles

```plaintext
PS Z:\Profilarr> python deletarr.py
Choose what to delete:
1. Custom Formats
2. Quality Profiles
Enter your choice (1/2): 2
Deleting selected quality profiles...
Available items:
1. 1080p Balanced
...
11. 2160p Optimal
Your choice: all
Deleting quality profile '1080p Balanced': SUCCESS
...
Deleting quality profile '2160p Optimal': SUCCESS
```

### Radarr and Sonarr Compatibility

- You are only able to import / sync files to the app that is included in the file name (e.g. `Radarr` or `Sonarr`).
Expand All @@ -264,6 +326,10 @@ PS Z:\Profilarr>
- **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.

## Contributing

- I've added a docker compose file for testing custom formats / quality profiles. Run `docker-compose up -d` to start the Radarr/ Sonarr test containers. Add your API keys to the `config.yml` file and begin testing!

# 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.
Expand Down
Loading

0 comments on commit 2e5cabe

Please sign in to comment.