Description
rtorrent-notify aims to be a very simple tool to notify users of rtorrent-related events. It can actually be used for other kind of events, being mostly generic.
Upgrading
If you upgrade from rtorrent2rss, the event database will get erased because of format incompatibilities.
Requirements
PyRSS2Gen
argparse (or Python 2.7).
An irkerd server running on localhost (optional, only if you want IRC notifications)
Configuration
Add this to your .rtorrent.rc:
system.method.set_key = event.download.finished,rtnfy_finished,"execute=~/rtorrent-notify/rtorrent-notify,FINISH,$d.get_base_path=" system.method.set_key = event.download.inserted_new,rtnfy_inserted,"execute=~/rtorrent-notify/rtorrent-notify,INSERT,$d.get_name="
For older versions of rtorrent (pre 0.8.4):
on_finished = rtnfy_finished,"execute=~/rtorrent-notify/rtorrent-notify,FINISH,$d.get_base_path=" on_start = rtnfy_started,"execute=~/rtorrent-notify/rtorrent-notify,START,$d.get_name="
Unless you specify their location, the files (rtorrent-notify.db and rtorrent-notify.xml) will be written in the home directory. Start rtorrent-notify -h for more details.
Yes, it is that unreadable. FINISH and START are just strings, you can change them.
Some tips:
There are other events you might be interested in. As there is no documentation, you can try to grep for event. in rtorrent’s source code.
get_base_path doesn’t work with the “inserted” event, you can use get_name instead.
You will find a list of properties to use in ui/download.cc
Complete help for the rtorrent-notify command is available by running rtorrent-notify -h.
Examples
Advanced usage with some options would be:
"execute=~/rtorrent-notify/rtorrent-notify,-r,~/public_html/feed.xml,-n,irc://chat.freenode.net/mynick,FINISH,$d.get_base_path="
The target RSS feed is changed from the default.
This also sends a notification to the freenode nick mynick. -n is used instead of -i irc://chat.freenode.net/mynick,isnick as the , character is already used by rtorrent’s config.
Notifications to channels could be sent by -i irc://chat.freenode.net/mychannel.
Metadata
Release files for rtorrent-notify 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rtorrent-notify-1.0.0.tar.gz | 5.2 kB | Without provenance | Details for rtorrent-notify-1.0.0.tar.gz |
Release files / rtorrent-notify-1.0.0.tar.gz
| Download URL | rtorrent-notify-1.0.0.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
72c1ed4324857a740845410f69e2e91c56c590b854464e89a475ca4ba1c09fee
|
|
BLAKE2b-256 checksum How to use checksums |
910532b53ecf4c957a388640447680b0b30016f522b0b36712cca99e82623795
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for rtorrent-notify 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.