ArchLinux : Package support is present in the AUR. All my packages can be seen here: http://aur.archlinux.org/packages.php?SeB=m&K=kaivalagi
Ubuntu/Debian : All the script packages have now been copied into the Conky Companions PPA. Any package updates will be provided by the team through this new ppa. The ppa can be found here: https://launchpad.net/~conky-companions/+archive/ppa. To use this ppa first delete the old ppa files using this:
Then follow the modified first post instructions for the scripts
sudo rm /etc/apt/sources.list.d/m-buck* && sudo rm /etc/apt/sources.list.d/conkyhardcore*
This is a simple script to display what is current downloading in Transmission. The script talks to Transmission using rpc via the python-transmissionrpc package and allows templates...
This script requires Transmission (daemon) to be installed and running, with the rpc authentication requirement set to false, edit the /etc/transmission-daemon/settings.json file to set the rpc auth requirement to "false" when the daemon is stopped then reload and start it. Step by step instructions are in the "gotchas" section below.
There is a README with the install, I suggest you give it atleast a quick once over! It can be found in the installation folder, normally following the path of /usr/share/conky<scriptname>/
Method 1: Using apt
1) Add the repository to your OS install:
sudo add-apt-repository ppa:conky-companions/ppa
* Note if you are running 9.10 or below then refer to the PPA link at the end of this post for help on installing from the ppa, good guidance can be found on the launchpad site
2) Now that is done simply run the following to update your repo cache and install the script:
Method 2: Using deb file
sudo apt-get update && sudo apt-get install conkytransmission
Run the .deb file available at the Conky Companions PPA site here: https://launchpad.net/~conky-compani.../ppa/+packages
Warning, this will not ensure you are kept up-to-date. Only method 1 will do that
Method 3: Using tar.gz file
Extract all the contents of the tar.gz file to an appropriate folder, and edit the conkyTransmission script to point to the correct location where conkyTransmission.py is. The tar.gz file is available at the Conky Companions PPA site here: https://launchpad.net/~conky-compani.../ppa/+packages
Unless you are using a non-Debian based OS I don't suggest this. Users of Debian/Ubuntu flavour OS's should ideally use method 1.
Again will will not receive updates using this method. ONLY method 1 can do this for you
All further details on setup are orientated around the deb package based install, so may differ from what you choose your setup to be, if done using the tarball.
To use the script in conky in it's simplist form, you'll need an exec statement like this:
To use a template for custom output, I suggest you read the README attached, and take a look at the example conkyrc and template files that are installed to "/usr/share/conkytransmission/example".
You can get the current help options at any time by running:
Usage: conkyTransmission [options]
-h, --help show this help message and exit
-s SERVER, --server=SERVER
[default: 127.0.0.1] The server to connect to where
the transmission daemon is running
-p PORT, --port=PORT [default: 9091] The port to connect to where the
transmission daemon is running
-U USERNAME, --username=USERNAME
[default: ] Username to use when connecting
-P PASSWORD, --password=PASSWORD
[default: ] Password to use when connecting
-S, --showsummary Display summary output. This is affected by the
Hide torrent detail output, if used no torrent details
-t FILE, --torrenttemplate=FILE
Template file determining the format for each torrent.
Use the following placeholders: [name], [state],
[totaldone], [totalsize], [progress], [nofiles],
[downloadrate], [uploadrate], [eta], [currentpeers],
[currentseeds], [totalpeers], [totalseeds], [ratio].
-T FILE, --summarytemplate=FILE
Template file determining the format for summary
output. Use the following placeholders: [notorrents],
[totalprogress], [totaldone], [totalsize],
[totaldownloadrate], [totaluploadrate], [totaleta],
[currentpeers], [currentseeds], [totalpeers],
-a, --activeonly If set only info for torrents in an active state will
-l NUMBER, --limit=NUMBER
[default: 0] Define the maximum number of torrents to
display, zero means no limit.
-b SORTTYPE, --sortby=SORTTYPE
Define the sort method for output, can be "progress",
"queue", "eta", "download", "upload" and "ratio". Also
note that a torrent's state supersedes anything else
for sorting, in the order, from top to bottom:
downloading, seeding, queued, paused, unknown)
-v, --verbose Request verbose output, no a good idea when running
-V, --version Displays the version of the script.
--errorlogfile=FILE If a filepath is set, the script appends errors to the
--infologfile=FILE If a filepath is set, the script appends info to the
1) As mentioned in the initial blurb at the top this script uses transmissions RPC interface to get details of torrents. However to overcome permissions issues is will probably be necessary to edit the transmission daemon settings file so that RPC does not require any authentication. This shouldn't pose any security issues as routers/firewall defaults should cover that off.
I did the following to get it working in Ubuntu:
Step 1 - Stop the Transmission daemon and open the settings file for editing:
Step 2 - Make the changes to the settings, edit this line:
sudo /etc/init.d/transmission-daemon stop
gksudo gedit sudo /etc/transmission-daemon/settings.json &
to be this:
Step 3 - Close the file then reload and start the daemon
2) Conky has a default limitation of 128 bytes for any text output from a variable (such as execi). If you are creating large templates with more characters than the default buffer size can handle, the output will get truncated. If this happens you can override the default behaviour by setting as new buffer size before the TEXT section in your conkyrc file, as follows:
sudo /etc/init.d/transmission-daemon reload
sudo /etc/init.d/transmission-daemon start
Development history going forwards can be seen here https://code.launchpad.net/~conky-companions/+junk/conkytransmission
All packages available from me can be found here: https://launchpad.net/~conky-companions/+archive/ppa