[all variants] Conky Rhythmbox Python Script

[kaivalagi]

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

IMPORTANT NEWS

All the script packages have now been copied into the Conky Hardcore PPA. Any package updates will be provided by the team through this new ppa.

The ppa can be found here: https://launchpad.net/~conkyhardcore/+archive/ppa

To use this ppa first delete the old ppa files using this:

sudo rm /etc/apt/sources.list.d/m-buck*

Then follow the modified first post instructions for the scripts
__________________________________________________ __________________________________________________ ______________________________

Intro

This is a simple script to display what is current playing in Rhythmbox. The script talks to Rhythmbox using dbus, and allows the outputting of track info and the use of templates...

There is a README with the install and attached here, I suggest you give it atleast a quick once over!

Basic Install

Method 1: Using apt

1) Create the necessary list file for access to the conky repository by running one of these.

Karmic Koala:

sudo wget -q http://www.kaivalagi.com/ubuntu/ppa/conkyhardcore-karmic.list -O /etc/apt/sources.list.d/conkyhardcore-karmic.list

Jaunty Jackalope:

sudo wget -q http://www.kaivalagi.com/ubuntu/ppa/conkyhardcore-jaunty.list -O /etc/apt/sources.list.d/conkyhardcore-jaunty.list

Intrepid Ibex:

sudo wget -q http://www.kaivalagi.com/ubuntu/ppa/conkyhardcore-intrepid.list -O /etc/apt/sources.list.d/conkyhardcore-intrepid.list

Hardy Heron:

sudo wget -q http://www.kaivalagi.com/ubuntu/ppa/conkyhardcore-hardy.list -O /etc/apt/sources.list.d/conkyhardcore-hardy.list

2) Add the repository public key to your apt setup by running this:

wget -q http://www.kaivalagi.com/ubuntu/ppa/conkyhardcore-key.gpg -O- | sudo apt-key add -

3) Now that is done simply run the following to install

sudo apt-get update && sudo apt-get install conkyrhythmbox

Method 2: Using deb file

Download and run the attached .deb file

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 attached tar.gz file to an appropriate folder, and edit the conkyRhythmbox script to point to the correct location where conkyRhythmbox.py is.

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.


Usage Help

You can get the current help options at any time by running (change the path as necessary):

conkyRhythmbox -h

or

conkyRhythmbox --help

Usage: conkyRhythmbox [options]
Options:
  -h, --help            show this help message and exit
  -t FILE, --template=FILE
                        define a template file to generate output in one call.
                        A displayable item in the file is in the form
                        [--datatype=TI]. The following are possible options
                        within each item: --datatype,--ratingchar. Note that
                        the short forms of the options are not currently
                        supported! None of these options are applicable at
                        command line when using templates.
  -d DATATYPE, --datatype=DATATYPE
                        [default: TI] The data type options are: ST (status),
                        CA (coverart), TI (title), AL (album), AR (artist), GE
                        (genre), YR (year), TN (track number), FN (file name),
                        LE (length), PP (current position in percent), PT
                        (current position in time), VO (volume), RT (rating).
                        Not applicable at command line when using templates.
  -r CHAR, --ratingchar=CHAR
                        [default: *] The output character for the ratings
                        scale. Command line option overridden if used in
                        templates.
  -s TEXT, --statustext=TEXT
                        If defined the status text for the player will be
                        overridden. The text must be comma delimited in the
                        form 'Playing,Paused,Stopped'. Command line option
                        overridden if used in templates.
  -n, --nounknownoutput
                        Turn off unknown output such as "Unknown" for title
                        and "0:00" for length. Command line option overridden
                        if used in templates.
  -v, --verbose         Request verbose output, not a good idea when running
                        through conky!
  -V, --version         Displays the version of the script.
  --errorlogfile=FILE   If a filepath is set, the script appends errors to the
                        filepath.
  --infologfile=FILE    If a filepath is set, the script appends info to the
                        filepath.

Development History

Development history going forwards can be seen here https://code.launchpad.net/~m-buck/+junk/conkyrhythmbox

All packages available from me can be found here: https://launchpad.net/~conkyhardcore/+archive/ppa

I have also created a new website, for now it is relatively sparse, but it does details my conky scripts to a certain degree. You can find it here: http://www.kaivalagi.com

[HippyRandall]

W00T!!!
I can now get rid of exaile! at least until they come out with 0.3 or w/e it is. Thanks man. Now to figure out a new layout...

Hippy

[kaivalagi]

I couldn't help myself, I found out how to get the dbus info for Rhythmbox so had to do it!

I am switching to Rhythmbox now too...

[kaivalagi]

UPDATE

I've updated the script as follows:

• Updated to handle when no music is playing, no unnecessary dbus calls will be made
• Updated rating output generation to use ljust string function

The first post attachments have been updated, and the apt package is available

[mp3_freak_721]

Noob here: how do you put it into you config file?

[kaivalagi]

Originally Posted by mp3_freak_721 Noob here: how do you put it into you config file?

Okay, if you install this using method 1 all the hard work is done for you without any possible problems...

Once you have installed the script can be run from the command line and through an exec call in conky as "conkyRhythmbox"

There is an example provided with the install, which if you open in an editor you'll see how things work. The file is: /usr/share/conkyrhythmbox/example/conkyrc

To run this example conky for this script, the following should be entered into the terminal:

conky -c /usr/share/conkyrhythmbox/example/conkyrc

All of this is in the README.txt file attached in the first post of this thread, I suggest you have a quick read

Any issues just ask...

[kaivalagi]

UPDATE

The script has been updated and is available in the first post and via apt, the changes are as follows:

• Updated script to now use "[" and "]" as template brackets rather than "{" and "}" so that the execp/execpi conky command can be used, this enables the use of $font, $color options in the template which conky will then make adjustments for in the output!
• Updated example files to use new template functionality with execpi in conky
• Updated README for usage changes

Note the change to templates, [] rather than {} for options now....

Have fun

[daveg]

I guess you didn't realise this, but there's already a command that does this which is part of the rhythmbox package (and has been for quite some time) called rhythmbox-client:

$ rhythmbox-client --help
Usage:
  rhythmbox-client [OPTION...]

Help Options:
  -?, --help                 Show help options

Application Options:
  --debug                    
  --no-start                 Don't start a new instance of Rhythmbox
  --quit                     Quit Rhythmbox
  --no-present               Don't present an existing Rhythmbox window
  --hide                     Hide the Rhythmbox window
  --next                     Jump to next song
  --previous                 Jump to previous song
  --notify                   Show notification of the playing song
  --play                     Resume playback if currently paused
  --pause                    Pause playback if currently playing
  --play-pause               Toggle play/pause mode
  --play-uri=URI to play     Play a specified URI, importing it if necessary
  --enqueue                  Add specified tracks to the play queue
  --clear-queue              Empty the play queue before adding new tracks
  --print-playing            Print the title and artist of the playing song
  --print-playing-format     Print formatted details of the song
  --set-volume               Set the playback volume
  --volume-up                Increase the playback volume
  --volume-down              Decrease the playback volume
  --print-volume             Print the current playback volume
  --mute                     Mute playback
  --unmute                   Unmute playback

[kaivalagi]

Originally Posted by daveg I guess you didn't realise this, but there's already a command that does this which is part of the rhythmbox package (and has been for quite some time) called rhythmbox-client:

Yes, I did know it was there, but this script allows for easier and better formatting of output, especially via a template file and the execpi/execp conky commands...

rhythmbox-client is great for controlling the music player from the console, but unless users want to spend hours on grep, sed and cut commands to strip and format the required details, it isn't a great tool to display current song details.

Your call if you want to use the script or not

[champs]

I gave the Rhythmbox a go..... working my way through your signature links.

It worked a treat, straight away, but I have noticed that when the song changes, a line from the previous line gets left behind, and pushes everything else up a line or two.

Screenshots below are from the 5th and 9th songs, and after the last song of the album finished.