Deluge Announce

A script that will announce torrents on a timed interval (CRON).

Prerequisites

• Python 3.10 or higher
• Docker (if using Docker setup)

Setup

Options for Use

• Docker (link)
• Package (link)

Running the Docker Container

To run the Docker container with the appropriate environment variables, use the following command:

docker run -e "WEB_URL=<your_web_url>" -e "PASSWORD=<your_web_url_password>" -e "CRON_SCHEDULE=0 * * * *" -e "SKIP_RE_ANNOUNCE=too many requests" -e "FORCE_RE_ANNOUNCE=warning|error" -e "FORCE_RE_ANNOUNCE_NEW_TORRENTS_INTERVAL=60" -e "FORCE_RE_ANNOUNCE_NEW_TORRENTS_MAX_AGE=300" -e "LOG_LEVEL=Info" -v "app_data:/app_data"

SKIP_RE_ANNOUNCE and SKIP_RE_ANNOUNCE expects pipe operator | separated strings. i.e. SKIP_RE_ANNOUNCE=reason1|reason2

Optionally you can provide the below variables that will check for newly added torrents and announce them as needed

FORCE_RE_ANNOUNCE_NEW_TORRENTS_INTERVAL: If set to anything greater than 0, the program will look for new torrents and re-announce them if less than the max age.

FORCE_RE_ANNOUNCE_NEW_TORRENTS_MAX_AGE: Max age of new torrents qualify to be force re-announced.

Optional

LOG_LEVEL defaults to Info. It can be any of Debug, Info, Warning, Error, or Critical. (Case insensitive)

This command will mount the app_data volume to persist logs across container restarts.

Running the Script as a Package

1. Install the package

poetry add deluge-announce
# or
pip install deluge-announce

2. Use in your Python code

from deluge_announce import Announcer
announcer = Announcer(
    web_url="https://yourweburl.com/",
    password="YOUR PASSWORD",
    cron_schedule="0 * * * *", # runs every hour
    skip_re_announce=["too many requests"], # defaults
    force_re_announce=["warning", "error"]  # defaults
    log_level="Info", # defaults to INFO from enum LogLevel. Strings are also accepted "Debug", "Info", "Warning", "Error", or "Critical". (Case insensitive)
    force_re_announce_new_torrents_interval=60, # optional, ignored if not using `run_forever`
    force_re_announce_new_torrents_max_age=300, # optional, ignored if not using `run_forever`
)

# Run the notifier once
announcer.run()

# Or run continuously as scheduled by cron
announcer.run_forever()

Checking Logs

Outside of Docker, you can view the logs in ./app_data/logs/.

Notes

• The app_data volume is used for persistent storage.
• If you're running the script outside Docker, the app_data folder will be created in your local directory to store logs and the database.
• The cron_schedule format follows standard cron syntax for scheduling tasks. For example, 0 * * * * runs the script every hour.

Troubleshooting

• Error Logs: If something goes wrong, check the logs at ./app_data/logs/ for more details.