rikpg / NetWatcher

Deluge plugin monitoring the local network activity and deciding if pause or resume all torrents.
13 stars 3 forks source link

================= Deluge NetWatcher

NetWatcher is a plugin for the Deluge bittorrent client that can limit the torrent activity in case other ip-addresses were to be found connected on the same network.

Features:

Usage

Working rationale as follow:

Complete Scan

A complete scan on the range 192.168.1.2-255 will be performed every X minutes.

This option is basically a shortcut for who doesn't want to deal with more detailed settings.

Quick Scan

A list of comma separated ip-addresses can be inserted in the Ip Addresses field (e.g., 192.168.1.45, 192.168.1.120-128, 192.168.1.149). These addresses only (and no others) will be cheked every X minutes.

Ranges can be specified with a dash sign on the last number:

192.168.1.2-4

is equivalent to:

192.168.1.2, 192.168.1.3, 192.168.1.4

Note: In both scan options the ip-addresses will be checked through ping requests.

Whitelist

The ip-addresses specified in the Whitelist field will not be checked. This feature is applied to both scan modes.

Note: The ip-addresses list follows the same comma separated format explained above. With range support of course.

Bandwidth Limits

It's possible to set upload and download bandwidth limits that will be applied in case of a busy network.

Note: A download speed limit set to 0 will cause the torrents to be paused.

Custom logging

It's also possibile to log the NetWatcher activity into a file.

This might come in handy if combined with a Dropbox-like service, making it very easy to monitor the torrents status without having to access the web-interface. For this reason the log-file format is .txt.

Installation

  1. Download the source code (available here):

    $ git clone git@github.com:rikpg/NetWatcher.git
  2. Build the egg and copy it into the deluge plugins directory:

    $ cd NetWatcher
    $ python setup.py bdist_egg
    $ cp dist/*.egg ~/.config/deluge/plugins

For developers:

As an alternative to copying, the egg can be linked with the following setuptools develop command:

$ python setup.py develop -mxd ~/.config/deluge/plugins

Development

The Netwatcher source code is hosted on GitHub and documented at my best ;)

Please feel free to submit Pull Requests and report bugs on the issue tracker.