Changeset 0654705e9cebf971ac00e733c920e9548ae3adcd

Timestamp:

12/16/10 01:24:03 (2 years ago)

Author:

Guillaume Pellerin <yomguy@…>

Children:

7728f7fb84077743867feb0e8c5e30fb1240fd25

Parents:

4334dd720924e001899883b2e290849dc6d9f68d

git-committer:

Guillaume Pellerin <yomguy@parisson.com> / 2010-12-16T00:24:03Z+0000

Message:

add new twitter oauth methods, update doc

Files:

• INSTALL (modified) (2 diffs)
• README (modified) (3 diffs)
• deefuzzer.py (modified) (1 diff)
• example/myfuzz.xml (modified) (1 diff)
• tools/get_access_token.py (added)
• tools/station.py (modified) (4 diffs)
• tools/twitt.py (modified) (2 diffs)

INSTALL

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2007-2009 Guillaume Pellerin <pellerin@parisson.com>
+# Copyright (c) 2007-2010 Guillaume Pellerin <pellerin@parisson.com>
 # All rights reserved.
 #
@@ -10 +10 @@
 # Author: Guillaume Pellerin <pellerin@parisson.com>
 
- depends:  python, python-dev, python-xml, python-shout | shout-python, libshout3,
+
+Dependencies
+=============
+
+depends:  python, python-dev, python-xml, python-shout | shout-python, libshout3,
            libshout3-dev, python-mutagen
 
- provides:  shout-python
+provides:  shout-python | python-shout, python-tinyurl
 
- optional: python-twitter, python-tinyurl, python-liblo | pyliblo (>= 0.26)
+optional: python-twitter, python-liblo | pyliblo (>= 0.26)
 
- recommends: icecast2
+recommends: icecast2
 
-python-shout is included in the DeeFuzzer but needs to be compiled and installed
-if you don't install deefuzzer from its debian package with aptitude.
-As explained in shout-python/INSTALL, you just have to run this command :
 
-  $ cd shout-python
-  $ sudo python setup.py install
+Install
+=========
 
-To install the DeeFuzzer (from the main deefuzzer directory) :
-
-  $ sudo python install.py
+To install the DeeFuzzer, go to the main deefuzzer app directory, for example::
+    
+    cd deefuzzer-0.4.3
+    
+and run the python installer::
+    
+    sudo python install.py
 
 For more informations, see http://svn.parisson.org/deefuzzer/
+
+
+Twitter (optional)
+=====================
+
+To get track twitting, please install python-twitter, python-oauth2 and all their dependencies.
+As Twitter now requires oauth key system since 07/2010, you need to get your own access token key pair.
+Please run the dedicated script to do this::
+    
+    python tools/get_access_token.py
+    
+You will be invited to copy/paste an URL in your browser to get a pin code.
+Then copy/paste this code into the console and press ENTER.
+The script gives you a pair of keys : one access token key and one access token secret key.
+
+Change the <twitter> block options in your deefuzzer XML config file, giving the 2 keys. 
+For example::
+    
+    <twitter>
+            <mode>1</mode>
+            <key>85039615-H6yAtXXCx7NobF5W40FV0c8epGZsQGkE7MG6XRjD2</key>
+            <secret>A1YW3llB9H9qVbjH8zOQTOkMlhVqh2a7LnA9Lt0b6Gc</secret>
+            <tags>Music Groove</tags>
+    </twitter>
+    
+Your DeeFuzzer will now tweet the currently playing track and new tracks on your profile.
+
+
+OSC Control
+=============
+
+Working, but no doc yet. Please read the code :)
+

README

@@ -50 +50 @@
 where CONFIGFILE is the path for a XML config file. For example::
 
-$ deefuzzer example/myfuzz.xml
+    deefuzzer example/myfuzz.xml
 
 To make the deefuzzer act as a deamon, just play it in the background::
 
-$ deefuzzer example/myfuzz.xml &
+    deefuzzer example/myfuzz.xml &
 
 Note that you must edit the config file with right parameters before playing.
@@ -67 +67 @@
 after a CTRL+Z, making this::
 
-$ kill -9 PROCESS_ID
+    kill -9 PROCESS_ID
 
 or::
 
-$ kill -9 `pgrep deefuzzer`
+    pkill -9 deefuzzer
 
 
@@ -90 +90 @@
 Next track::
 
-$ python tools/osc_next.py
+    python tools/osc_next.py
 
 Start twitting::
 
-$ python tools/osc_twitter_start.py
+    python tools/osc_twitter_start.py
 
 Stop twitting::
 
-$ python see tools/osc_twitter_stop.py
+    python see tools/osc_twitter_stop.py
 
 Start relaying::
 
-$ python tools/osc_relay_start.py
+    python tools/osc_relay_start.py
 
 Stop relaying::
 
-$ python see tools/osc_relay_stop.py
+    python see tools/osc_relay_stop.py
 
 Start jingling::
 
-$ python see tools/osc_jingles_start.py
+    python see tools/osc_jingles_start.py
 
 Stop jingling::
 
-$ python see tools/osc_jingles_stop.py
+    python see tools/osc_jingles_stop.py
 
 

deefuzzer.py

@@ -46 +46 @@
 from tools import *
 
-version = '0.4.3'
+version = '0.5.0'
 year = datetime.datetime.now().strftime("%Y")
 platform_system = platform.system()

example/myfuzz.xml

@@ -61 +61 @@
             <mode>0</mode>
             <!-- Your twitter username -->
-            <user>my_twitter_user</user>
+            <key>your access token key</key>
             <!-- Your twitter password -->
-            <pass>my_twitter_password</pass>
+            <secret>your access token secret key</secret>
             <!-- These tags will be added to each twitter message -->
             <tags>bla bla</tags>

tools/station.py

@@ -145 +145 @@
         if 'twitter' in self.station:
             self.twitter_mode = int(self.station['twitter']['mode'])
-            self.twitter_user = self.station['twitter']['user']
-            self.twitter_pass = self.station['twitter']['pass']
+            self.twitter_key = self.station['twitter']['key']
+            self.twitter_secret = self.station['twitter']['secret']
             self.twitter_tags = self.station['twitter']['tags'].split(' ')
             if self.twitter_mode == 1:
@@ -213 +213 @@
         value = value[0]
         import tinyurl
-        self.twitter = Twitter(self.twitter_user, self.twitter_pass)
+        self.twitter = Twitter(self.twitter_key, self.twitter_secret)
         self.twitter_mode = value
         message = "Received OSC message '%s' with arguments '%d'" % (path, value)
@@ -449 +449 @@
         #self.channel.set_metadata({'song': self.song, 'charset': 'utf8',})
         self.update_rss(self.current_media_obj, self.rss_current_file, '(currently playing)')
-        self.logger.write_info('Deefuzzing on %s :  id = %s, name = %s' \
+        self.logger.write_info('DeeFuzzing on %s :  id = %s, name = %s' \
             % (self.short_name, self.id, self.current_media_obj[0].file_name))
         self.player.set_media(self.media)
@@ -460 +460 @@
         artist_names = self.artist.split(' ')
         artist_tags = ' #'.join(list(set(artist_names)-set(['&', '-'])))
-        message = '♫ %s %s on #%s #%s' % (self.prefix, self.song, self.short_name, artist_tags)
+        message = '%s %s on #%s #%s' % (self.prefix, self.song, self.short_name, artist_tags)
         tags = '#' + ' #'.join(self.twitter_tags)
         message = message + ' ' + tags

tools/twitt.py

@@ -38 +38 @@
 
 # Twitter DeeFuzzer keys
-TWITTER_CONSUMER_KEY = 'ozs9cPS2ci6eYQzzMSTb4g'
-TWITTER_CONSUMER_SECRET = '1kNEffHgGSXO2gMNTr8HRum5s2ofx3VQnJyfd0es'
+DEEFUZZER_CONSUMER_KEY = 'ozs9cPS2ci6eYQzzMSTb4g'
+DEEFUZZER_CONSUMER_SECRET = '1kNEffHgGSXO2gMNTr8HRum5s2ofx3VQnJyfd0es'
 
 
@@ -46 +46 @@
     def __init__(self, access_token_key, access_token_secret):
         import twitter
-        self.username = TWITTER_CONSUMER_KEY
-        self.password = TWITTER_CONSUMER_SECRET
+        self.consumer_key = DEEFUZZER_CONSUMER_KEY
+        self.consumer_secret = DEEFUZZER_CONSUMER_SECRET
         self.access_token_key = access_token_key
         self.access_token_secret = access_token_secret
-        self.api = twitter.Api(username=self.username,
-                               password=self.password,
+        self.api = twitter.Api(consumer_key=self.consumer_key,
+                               consumer_secret=self.consumer_secret,
                                access_token_key=self.access_token_key,
                                access_token_secret=self.access_token_secret)