Skip to content

Update index.md - #2749

Draft
platnub wants to merge 2 commits into
TRaSH-Guides:masterfrom
platnub:patch-2
Draft

Update index.md#2749
platnub wants to merge 2 commits into
TRaSH-Guides:masterfrom
platnub:patch-2

Conversation

@platnub

@platnub platnub commented May 22, 2026

Copy link
Copy Markdown

Added instruction to check python3 path in Docker.

Pull Request

Purpose

Scripts don't run if python3 path is incorrect.

Approach

This informs users that the python3 path is important for the scripts to run successfully and a basic step how to fix it.

Open Questions and Pre-Merge TODOs

Requirements

Summary by Sourcery

Documentation:

  • Add guidance to verify the python3 installation location and update the script shebang accordingly in the SABnzbd scripts documentation.

@github-actions github-actions Bot added Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related labels May 22, 2026
@sourcery-ai

sourcery-ai Bot commented May 22, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a documentation note instructing users to verify the python3 installation path in Docker when configuring SABnzbd scripts, to prevent script execution failures.

Flow diagram for updated SABnzbd script setup checklist

flowchart TD
    A[Create scripts folder in SABnzbd root] --> B[Set scripts folder in SABnzbd settings]
    B --> C[Ensure script has execute permissions]
    C --> D[Check python3 path with `which python3` and update script shebang]
Loading

File-Level Changes

Change Details Files
Document requirement to verify python3 path for SABnzbd scripts.
  • Add a bullet point reminding users to check the python3 installation location using which python3.
  • Explain that the discovered path should replace the interpreter path at the start of the script to ensure scripts run correctly in Docker environments.
docs/Downloaders/SABnzbd/scripts/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions

Copy link
Copy Markdown
Contributor

Deploying with ⚡ Cloudflare Pages

Latest commit:261d5665fefd3dbc86a7fe78d78c22b4628346c4
Status: ✅  Deploy successful!
Preview URL:https://7ba2e7a1.trash-guides-6xu.pages.dev
Branch Preview URL:https://pr-2749.trash-guides-6xu.pages.dev

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue, and left some high level feedback:

  • Consider clarifying that the python3 path should be used in the script’s shebang line (e.g., #!/usr/bin/env python3 or a concrete path) so users know exactly where to apply the result of which python3.
  • It may be helpful to note that which python3 is intended for Unix-like environments and briefly mention an equivalent approach for Windows users, or explicitly scope the instruction to Linux/macOS.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider clarifying that the python3 path should be used in the script’s shebang line (e.g., `#!/usr/bin/env python3` or a concrete path) so users know exactly where to apply the result of `which python3`.
- It may be helpful to note that `which python3` is intended for Unix-like environments and briefly mention an equivalent approach for Windows users, or explicitly scope the instruction to Linux/macOS.

## Individual Comments

### Comment 1
<location path="docs/Downloaders/SABnzbd/scripts/index.md" line_range="14" />
<code_context>
 - You've created folder called `scripts` in the root directory of SABnzbd
 - You've set the `scripts` folder inside the SABnzbd settings under `Folder > User Folders > Scripts Folder`. ([More Infos](https://sabnzbd.org/wiki/configuration/4.3/folders))
 - Your script got sufficient rights to execute. ([More Infos](https://sabnzbd.org/wiki/configuration/4.5/scripts/post-processing-scripts))
+- You've checked the installation location for python3 using `which python3` to replace the path at the start of the script.

 ## Clean
</code_context>
<issue_to_address>
**nitpick (typo):** Consider capitalizing and spacing "Python 3" as a proper name.

In this bullet, use “Python 3” in the prose, while keeping the command `which python3` unchanged in backticks.

```suggestion
- You've checked the installation location for Python 3 using `which python3` to replace the path at the start of the script.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/Downloaders/SABnzbd/scripts/index.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Deploying with ⚡ Cloudflare Pages

Latest commit:ca6ec10ce5a9cb8b59b6e732f2eebe68eaa5440e
Status: ✅  Deploy successful!
Preview URL:https://c5c3101f.trash-guides-6xu.pages.dev
Branch Preview URL:https://pr-2749.trash-guides-6xu.pages.dev

@TRaSH-

TRaSH- commented May 22, 2026

Copy link
Copy Markdown
Contributor

Thanks for this PR. I approved your suggestion, but you still need to fix a few things before it's approved.
https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md#pull-request-naming
Use downloaders as a guide category.

@TRaSH- TRaSH- added the Status: Waiting for User Waiting for OP or Contributor to address feedback or provide information label May 23, 2026
@TRaSH-

TRaSH- commented May 23, 2026

Copy link
Copy Markdown
Contributor

@platnub

@bakerboy448
bakerboy448 marked this pull request as draft June 21, 2026 03:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related Status: Waiting for User Waiting for OP or Contributor to address feedback or provide information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants