quasarr 1.26.7__tar.gz → 1.28.0__tar.gz

{quasarr-1.26.7 → quasarr-1.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quasarr
-Version: 1.26.7
+Version: 1.28.0
 Summary: Quasarr connects JDownloader with Radarr, Sonarr and LazyLibrarian. It also decrypts links protected by CAPTCHAs.
 Home-page: https://github.com/rix1337/Quasarr
 Author: rix1337
@@ -44,97 +44,121 @@ Alternatively, follow the link from the console output (or discord notification)
 Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be installed in your browser.
 
 # Instructions
-1. Set up and run [FlareSolverr 3](https://github.com/FlareSolverr/FlareSolverr).
-2. Set up and run [JDownloader 2](https://jdownloader.org/download/index).
-3. Follow the next steps.
+
+# Instructions
+
+1. Set up and run [JDownloader 2](https://jdownloader.org/download/index)
+2. Configure the integrations below
+3. (Optional) Set up [FlareSolverr 3](https://github.com/FlareSolverr/FlareSolverr) for sites that require it
+
+> **Finding your Quasarr URL and API Key**  
+> Both values are shown in the console output under **API Information**, or in the Quasarr web UI.
 
 ---
 
-## FlareSolverr
-1. Ensure your running FlareSolverr is reachable by Quasarr.
-2. Provide your FlareSolverr URL to Quasarr during the setup process.
-3. The full URL must include the version path, e.g., `http://192.168.1.1:8191/v1`.
+## FlareSolverr (Optional)
+
+FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip FlareSolverr during setup and configure it later via the web UI.
+
+If using FlareSolverr, provide your URL including the version path:
+```
+http://192.168.1.1:8191/v1
+```
+
+> **Note:** Sites requiring FlareSolverr will show a warning in the console when it's not configured.
 
 ---
 
 ## Quasarr
 
-Tell Quasarr which sites to search for releases. It requires at least one valid source to start up.
+> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but community-maintained lists are available:
+
+🔗 **[quasarr-hostnames.pages.dev](https://quasarr-hostnames.pages.dev)** — third-party guide for finding hostnames
 
-> - By default, Quasarr does **not** know which sites to scrape for download links.  
-> - The setup will guide you through the process of providing valid hostnames for Quasarr to scrape.  
-> - Do **not** ask for help here if you do not know which hostnames to use. Picking them is solely your responsibility.  
-> - You may check sites like [Pastebin](https://pastebin.com/search?q=hostnames+quasarr) for user‑submitted suggestions.
+📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (login required).
 
 ---
 
 ## JDownloader
 
-1. Ensure your running JDownloader is connected to the My JDownloader service.  
-2. Provide your [My‑JDownloader‑Credentials](https://my.jdownloader.org) to Quasarr during the setup process.
+> ⚠️ If using Docker: 
+> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external path mappings**!
+> Matching only the external path is not sufficient.
+
+1. Start and connect JDownloader to [My JDownloader](https://my.jdownloader.org)
+2. Provide your My JDownloader credentials during Quasarr setup
+
+<details>
+<summary>Fresh install recommended</summary>
+
+Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable Radarr/Sonarr/LazyLibrarian integration.
 
-> - Consider setting up a fresh JDownloader before you begin.  
-> - JDownloader must be running and available to Quasarr.  
-> - Quasarr will modify JDownloader’s settings so downloads can be handled by Radarr/Sonarr/LazyLibrarian.  
-> - If using Docker, ensure that JDownloader’s download path is available to Radarr/Sonarr/LazyLibrarian with **exactly the same** internal and external path mapping (matching only the external path is not enough).
+</details>
 
 ---
 
 ## Radarr / Sonarr
 
-Set up Quasarr as a **Newznab Indexer** and **SABnzbd Download Client**:
+> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for shows set to Anime/Absolute.
 
-1. **URL**: Use the `URL` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-2. **API Key**: Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-3. Leave all other settings at their defaults.
 
-> **Important notice for Sonarr**  
-> - Ensure all shows (including anime) are set to the **Standard** series type.  
-> - Quasarr will never find releases for shows set to **Anime / Absolute**.
+Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using your Quasarr URL and API Key.
+
+<details>
+<summary>Show download status in Radarr/Sonarr</summary>
+
+**Activity → Queue → Options** → Enable `Release Title`
+
+</details>
+
+<details>
+<summary>Restrict results to a specific mirror</summary>
+
+Append the mirror name to your Newznab URL:
+```
+/api/dropbox/
+```
+Only releases with `dropbox` in a link will be returned. If the mirror isn't available, the release will fail.
+
+</details>
 
 ---
 
 ## LazyLibrarian
 
-> **Important notice**
-> - This feature is experimental and may not work as expected.
-> - Quasarr cannot help you with metadata issues, missing covers, or other LazyLibrarian problems.
-> - Please report issues when one of your hostnames yields results through their website, but not in LazyLibrarian.
-
-Set up Quasarr as a **SABnzbd+ Downloader**
+> ⚠️ **Experimental feature** — Report issues when a hostname returns results on its website but not in LazyLibrarian.
 
-1. **SABnzbd URL/Port**: Use port and host parts from `URL` found in the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-2. **SABnzbd API Key**: Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-3. **SABnzbd Category**: Use `docs` to ensure LazyLibrarian does not interfere with Radarr/Sonarr.  
-4. Press `Test SABnzbd` to verify the connection, then `Save changes`.
+<details>
+<summary>Setup instructions</summary>
 
-Set up Quasarr as a **Newznab Provider**:
-1. **Newznab URL**: Use the `URL` from the **API Information** section of the console output (or copy it from the Quasarr web UI).
-2. **Newznab API** Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).
-3. Press `Test` to verify the connection, then `Save changes`.
+### SABnzbd+ Downloader
 
-Fix the `Importing` settings:
-1. Check `Enable OpenLibrary api for book/author information`
-2. Select `OpenLibrary` below `Primary Information Source`
-2. Under `Import languages` add `, Unknown` (and for German users: `, de, ger, de-DE`).
+| Setting | Value |
+|---------|-------|
+| URL/Port | Your Quasarr host and port |
+| API Key | Your Quasarr API Key |
+| Category | `docs` |
 
-Fix the `Processing` settings:
-1. Under `Folders` add the full Quasarr download path, typically `/downloads/Quasarr/`
-2. If you do not do this,  processing after the download will fail.
+### Newznab Provider
 
+| Setting | Value |
+|---------|-------|
+| URL | Your Quasarr URL |
+| API | Your Quasarr API Key |
 
+### Fix Import & Processing
 
----
+**Importing:**
+- Enable `OpenLibrary api for book/author information`
+- Set Primary Information Source to `OpenLibrary`
+- Add to Import languages: `, Unknown` (German users: `, de, ger, de-DE`)
 
-## Advanced Settings
+**Processing → Folders:**
+- Add your Quasarr download path (typically `/downloads/Quasarr/`)
 
-To restrict results to a specific mirror, add the mirror name to the Newznab/indexer URL.  
-> **Example:** Appending `/api/dropbox/` will only return releases where `dropbox` is explicitly mentioned in a link.  
-> **Caution:** If a mirror is not available at a hostname, the release will be ignored or the download will fail. Use this option carefully.
+</details>
 
-To see download status information in Radarr/Sonarr
-1. Open `Activity` → `Queue` → `Options`
-2. Enable `Release Title`
+---
 
 # Docker
 
@@ -173,8 +197,6 @@ Use this only in case you can't run the docker image.
 `pip install quasarr`
 
 * Requires Python 3.12 or later
-* Requires [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr)
-* Requires [JDownloader 2](https://jdownloader.org/download/index) with [My JDownloader](https://my.jdownloader.org/)
 
 ```
   --port=8080
@@ -205,10 +227,11 @@ Most feature requests can be satisfied by:
 - Still having an issue? Provide a detailed report [here](https://github.com/rix1337/Quasarr/issues/new/choose)!
 - There are no hostname integrations in active development unless you see an open pull request
   [here](https://github.com/rix1337/Quasarr/pulls).
-- Pull requests are welcome. Especially for popular hostnames.
+- **Pull requests are welcome!** Especially for popular hostnames.
+    - A short guide to set up required dev services is found in [/docker/dev-setup.md](https://github.com/rix1337/Quasarr/blob/main/docker/dev-setup.md)
     - Always reach out on Discord before starting work on a new feature to prevent waste of time.
     - Please follow the existing code style and project structure.
-    - Anti-bot measures must be circumvented fully by Quasarr. Thus you will need to provide a working solution for new
+    - Anti-bot measures must be circumvented fully by Quasarr. Thus, you will need to provide a working solution for new
       CAPTCHA types by integrating it in the Quasarr Web UI.
     - Please provide proof of functionality (screenshots/examples) when submitting your pull request.
 
@@ -238,6 +261,8 @@ Image access is limited to [active monthly GitHub sponsors](https://github.com/u
 
 ## 🐋 Docker Login
 
+⚠️ **Before logging in, the image will not download.**
+
 ```bash
 echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
 ````
@@ -245,14 +270,10 @@ echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
 * `USERNAME` → your GitHub username
 * `GITHUB_TOKEN` → the token you just created
 
----
-
-⚠️ **Before logging in, the image will not download.**
-
----
-
 ## ▶️ Run SponsorsHelper
 
+⚠️ **Without a valid GitHub token linked to an active sponsorship, the image will not run.**
+
 ```bash
 docker run -d \
   --name='SponsorsHelper' \
@@ -268,8 +289,6 @@ docker run -d \
   ghcr.io/rix1337-sponsors/docker/helper:latest
 ```
 
-### Required Parameters
-
 * `QUASARR_URL` → Local URL of Quasarr
 * `DEATHBYCAPTCHA_TOKEN` → [DeathByCaptcha](https://deathbycaptcha.com/register?refid=6184288242b) account token
 * `GITHUB_TOKEN` → Classic GitHub PAT with the scopes listed above
@@ -277,30 +296,3 @@ docker run -d \
 * `NX_USER` / `NX_PASS` → NX account credentials
 * `JUNKIES_USER` / `JUNKIES_PASS` → Junkies account credentials
 * `JUNKIES_HOSTER` → Preferred hoster for Junkies links
----
-
-⚠️ **Without a valid GitHub token linked to an active sponsorship, the image will not run.**
-
----
-
-# Development Setup for Pull Requests
-
-To test your changes before submitting a pull request:
-
-**Run Quasarr with the `--internal_address` parameter:**
-
-```bash
-python Quasarr.py --internal_address=http://<host-ip>:<port>
-```
-
-Replace `<host-ip>` and `<port>` with the scheme, IP, and port of your host machine.
-The `--internal_address` parameter is **mandatory**.
-
-**Start the required services using the `dev-services-compose.yml` file:**
-
-```bash
-CONFIG_VOLUMES=/path/to/config docker-compose -f docker/dev-services-compose.yml up
-```
-
-Replace `/path/to/config` with your desired configuration location.
-The `CONFIG_VOLUMES` environment variable is **mandatory**.

{quasarr-1.26.7 → quasarr-1.28.0}/README.md

@@ -17,97 +17,121 @@ Alternatively, follow the link from the console output (or discord notification)
 Quasarr will confidently handle the rest. Some CAPTCHA types require [Tampermonkey](https://www.tampermonkey.net/) to be installed in your browser.
 
 # Instructions
-1. Set up and run [FlareSolverr 3](https://github.com/FlareSolverr/FlareSolverr).
-2. Set up and run [JDownloader 2](https://jdownloader.org/download/index).
-3. Follow the next steps.
+
+# Instructions
+
+1. Set up and run [JDownloader 2](https://jdownloader.org/download/index)
+2. Configure the integrations below
+3. (Optional) Set up [FlareSolverr 3](https://github.com/FlareSolverr/FlareSolverr) for sites that require it
+
+> **Finding your Quasarr URL and API Key**  
+> Both values are shown in the console output under **API Information**, or in the Quasarr web UI.
 
 ---
 
-## FlareSolverr
-1. Ensure your running FlareSolverr is reachable by Quasarr.
-2. Provide your FlareSolverr URL to Quasarr during the setup process.
-3. The full URL must include the version path, e.g., `http://192.168.1.1:8191/v1`.
+## FlareSolverr (Optional)
+
+FlareSolverr is **optional** but **required for some sites** (e.g., AL) that use Cloudflare protection. You can skip FlareSolverr during setup and configure it later via the web UI.
+
+If using FlareSolverr, provide your URL including the version path:
+```
+http://192.168.1.1:8191/v1
+```
+
+> **Note:** Sites requiring FlareSolverr will show a warning in the console when it's not configured.
 
 ---
 
 ## Quasarr
 
-Tell Quasarr which sites to search for releases. It requires at least one valid source to start up.
+> ⚠️ Quasarr requires at least one valid hostname to start. It does not provide or endorse any specific sources, but community-maintained lists are available:
+
+🔗 **[quasarr-hostnames.pages.dev](https://quasarr-hostnames.pages.dev)** — third-party guide for finding hostnames
 
-> - By default, Quasarr does **not** know which sites to scrape for download links.  
-> - The setup will guide you through the process of providing valid hostnames for Quasarr to scrape.  
-> - Do **not** ask for help here if you do not know which hostnames to use. Picking them is solely your responsibility.  
-> - You may check sites like [Pastebin](https://pastebin.com/search?q=hostnames+quasarr) for user‑submitted suggestions.
+📋 Alternatively, browse community suggestions via [pastebin search](https://pastebin.com/search?q=hostnames+quasarr) (login required).
 
 ---
 
 ## JDownloader
 
-1. Ensure your running JDownloader is connected to the My JDownloader service.  
-2. Provide your [My‑JDownloader‑Credentials](https://my.jdownloader.org) to Quasarr during the setup process.
+> ⚠️ If using Docker: 
+> JDownloader's download path must be available to Radarr/Sonarr/LazyLibrarian with **identical internal and external path mappings**!
+> Matching only the external path is not sufficient.
+
+1. Start and connect JDownloader to [My JDownloader](https://my.jdownloader.org)
+2. Provide your My JDownloader credentials during Quasarr setup
+
+<details>
+<summary>Fresh install recommended</summary>
+
+Consider setting up a fresh JDownloader instance. Quasarr will modify JDownloader's settings to enable Radarr/Sonarr/LazyLibrarian integration.
 
-> - Consider setting up a fresh JDownloader before you begin.  
-> - JDownloader must be running and available to Quasarr.  
-> - Quasarr will modify JDownloader’s settings so downloads can be handled by Radarr/Sonarr/LazyLibrarian.  
-> - If using Docker, ensure that JDownloader’s download path is available to Radarr/Sonarr/LazyLibrarian with **exactly the same** internal and external path mapping (matching only the external path is not enough).
+</details>
 
 ---
 
 ## Radarr / Sonarr
 
-Set up Quasarr as a **Newznab Indexer** and **SABnzbd Download Client**:
+> ⚠️ **Sonarr users:** Set all shows (including anime) to the **Standard** series type. Quasarr cannot find releases for shows set to Anime/Absolute.
 
-1. **URL**: Use the `URL` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-2. **API Key**: Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-3. Leave all other settings at their defaults.
 
-> **Important notice for Sonarr**  
-> - Ensure all shows (including anime) are set to the **Standard** series type.  
-> - Quasarr will never find releases for shows set to **Anime / Absolute**.
+Add Quasarr as both a **Newznab Indexer** and **SABnzbd Download Client** using your Quasarr URL and API Key.
+
+<details>
+<summary>Show download status in Radarr/Sonarr</summary>
+
+**Activity → Queue → Options** → Enable `Release Title`
+
+</details>
+
+<details>
+<summary>Restrict results to a specific mirror</summary>
+
+Append the mirror name to your Newznab URL:
+```
+/api/dropbox/
+```
+Only releases with `dropbox` in a link will be returned. If the mirror isn't available, the release will fail.
+
+</details>
 
 ---
 
 ## LazyLibrarian
 
-> **Important notice**
-> - This feature is experimental and may not work as expected.
-> - Quasarr cannot help you with metadata issues, missing covers, or other LazyLibrarian problems.
-> - Please report issues when one of your hostnames yields results through their website, but not in LazyLibrarian.
-
-Set up Quasarr as a **SABnzbd+ Downloader**
+> ⚠️ **Experimental feature** — Report issues when a hostname returns results on its website but not in LazyLibrarian.
 
-1. **SABnzbd URL/Port**: Use port and host parts from `URL` found in the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-2. **SABnzbd API Key**: Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).  
-3. **SABnzbd Category**: Use `docs` to ensure LazyLibrarian does not interfere with Radarr/Sonarr.  
-4. Press `Test SABnzbd` to verify the connection, then `Save changes`.
+<details>
+<summary>Setup instructions</summary>
 
-Set up Quasarr as a **Newznab Provider**:
-1. **Newznab URL**: Use the `URL` from the **API Information** section of the console output (or copy it from the Quasarr web UI).
-2. **Newznab API** Use the `API Key` from the **API Information** section of the console output (or copy it from the Quasarr web UI).
-3. Press `Test` to verify the connection, then `Save changes`.
+### SABnzbd+ Downloader
 
-Fix the `Importing` settings:
-1. Check `Enable OpenLibrary api for book/author information`
-2. Select `OpenLibrary` below `Primary Information Source`
-2. Under `Import languages` add `, Unknown` (and for German users: `, de, ger, de-DE`).
+| Setting | Value |
+|---------|-------|
+| URL/Port | Your Quasarr host and port |
+| API Key | Your Quasarr API Key |
+| Category | `docs` |
 
-Fix the `Processing` settings:
-1. Under `Folders` add the full Quasarr download path, typically `/downloads/Quasarr/`
-2. If you do not do this,  processing after the download will fail.
+### Newznab Provider
 
+| Setting | Value |
+|---------|-------|
+| URL | Your Quasarr URL |
+| API | Your Quasarr API Key |
 
+### Fix Import & Processing
 
----
+**Importing:**
+- Enable `OpenLibrary api for book/author information`
+- Set Primary Information Source to `OpenLibrary`
+- Add to Import languages: `, Unknown` (German users: `, de, ger, de-DE`)
 
-## Advanced Settings
+**Processing → Folders:**
+- Add your Quasarr download path (typically `/downloads/Quasarr/`)
 
-To restrict results to a specific mirror, add the mirror name to the Newznab/indexer URL.  
-> **Example:** Appending `/api/dropbox/` will only return releases where `dropbox` is explicitly mentioned in a link.  
-> **Caution:** If a mirror is not available at a hostname, the release will be ignored or the download will fail. Use this option carefully.
+</details>
 
-To see download status information in Radarr/Sonarr
-1. Open `Activity` → `Queue` → `Options`
-2. Enable `Release Title`
+---
 
 # Docker
 
@@ -146,8 +170,6 @@ Use this only in case you can't run the docker image.
 `pip install quasarr`
 
 * Requires Python 3.12 or later
-* Requires [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr)
-* Requires [JDownloader 2](https://jdownloader.org/download/index) with [My JDownloader](https://my.jdownloader.org/)
 
 ```
   --port=8080
@@ -178,10 +200,11 @@ Most feature requests can be satisfied by:
 - Still having an issue? Provide a detailed report [here](https://github.com/rix1337/Quasarr/issues/new/choose)!
 - There are no hostname integrations in active development unless you see an open pull request
   [here](https://github.com/rix1337/Quasarr/pulls).
-- Pull requests are welcome. Especially for popular hostnames.
+- **Pull requests are welcome!** Especially for popular hostnames.
+    - A short guide to set up required dev services is found in [/docker/dev-setup.md](https://github.com/rix1337/Quasarr/blob/main/docker/dev-setup.md)
     - Always reach out on Discord before starting work on a new feature to prevent waste of time.
     - Please follow the existing code style and project structure.
-    - Anti-bot measures must be circumvented fully by Quasarr. Thus you will need to provide a working solution for new
+    - Anti-bot measures must be circumvented fully by Quasarr. Thus, you will need to provide a working solution for new
       CAPTCHA types by integrating it in the Quasarr Web UI.
     - Please provide proof of functionality (screenshots/examples) when submitting your pull request.
 
@@ -211,6 +234,8 @@ Image access is limited to [active monthly GitHub sponsors](https://github.com/u
 
 ## 🐋 Docker Login
 
+⚠️ **Before logging in, the image will not download.**
+
 ```bash
 echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
 ````
@@ -218,14 +243,10 @@ echo "GITHUB_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
 * `USERNAME` → your GitHub username
 * `GITHUB_TOKEN` → the token you just created
 
----
-
-⚠️ **Before logging in, the image will not download.**
-
----
-
 ## ▶️ Run SponsorsHelper
 
+⚠️ **Without a valid GitHub token linked to an active sponsorship, the image will not run.**
+
 ```bash
 docker run -d \
   --name='SponsorsHelper' \
@@ -241,8 +262,6 @@ docker run -d \
   ghcr.io/rix1337-sponsors/docker/helper:latest
 ```
 
-### Required Parameters
-
 * `QUASARR_URL` → Local URL of Quasarr
 * `DEATHBYCAPTCHA_TOKEN` → [DeathByCaptcha](https://deathbycaptcha.com/register?refid=6184288242b) account token
 * `GITHUB_TOKEN` → Classic GitHub PAT with the scopes listed above
@@ -250,30 +269,3 @@ docker run -d \
 * `NX_USER` / `NX_PASS` → NX account credentials
 * `JUNKIES_USER` / `JUNKIES_PASS` → Junkies account credentials
 * `JUNKIES_HOSTER` → Preferred hoster for Junkies links
----
-
-⚠️ **Without a valid GitHub token linked to an active sponsorship, the image will not run.**
-
----
-
-# Development Setup for Pull Requests
-
-To test your changes before submitting a pull request:
-
-**Run Quasarr with the `--internal_address` parameter:**
-
-```bash
-python Quasarr.py --internal_address=http://<host-ip>:<port>
-```
-
-Replace `<host-ip>` and `<port>` with the scheme, IP, and port of your host machine.
-The `--internal_address` parameter is **mandatory**.
-
-**Start the required services using the `dev-services-compose.yml` file:**
-
-```bash
-CONFIG_VOLUMES=/path/to/config docker-compose -f docker/dev-services-compose.yml up
-```
-
-Replace `/path/to/config` with your desired configuration location.
-The `CONFIG_VOLUMES` environment variable is **mandatory**.