--- /dev/null
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2007-2010 Guillaume Pellerin <pellerin@parisson.com>
+# All rights reserved.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at http://svn.parisson.org/deefuzzer/DeeFuzzLicense.
+#
+# Author: Guillaume Pellerin <pellerin@parisson.com>
+
+
+Dependencies
+=============
+
+depends: python, python-dev, python-xml, python-shout | shout-python, libshout3,
+ libshout3-dev, python-mutagen
+
+provides: shout-python | python-shout, python-tinyurl
+
+optional: python-twitter, python-liblo | pyliblo (>= 0.26)
+
+recommends: icecast2, python-setuptools
+
+
+Install
+=========
+
+Please first install libshout3 and liblo from source OR libshout3-dev and liblo-dev from your own distribution package manager.
+
+Now, the easiest way to install the DeeFuzzer from a shell::
+
+ sudo pip install deefuzzer
+
+or::
+
+ sudo easy_install install deefuzzer
+
+To install the DeeFuzzer from sources, go to the main deefuzzer app directory, for example::
+
+ cd deefuzzer-0.5.0
+
+and run::
+
+ sudo python setup.py install
+
+For more informations, see http://svn.parisson.org/deefuzzer/
+
+
+Twitter (manual and optional)
+================================
+
+To get track twitting, please install python-twitter, python-oauth2 and all their dependencies.
+
+Install python-oauth2::
+
+ sudo easy_install oauth2
+
+Get and install python-twitter (>= 0.8.1)::
+
+ wget http://python-twitter.googlecode.com/files/python-twitter-0.8.1.tar.gz
+ tar xzf python-twitter-0.8.1.tar.gz
+ cd python-twitter-0.8.1
+ sudo python setup.py install
+
+As Twitter access requires oauth keys since 07/2010, you need to get your own access token key pair.
+Please run the dedicated script to do this from the main deefuzzer app directory::
+
+ 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 :)
+
+++ /dev/null
-# -*- coding: utf-8 -*-
-#
-# Copyright (c) 2007-2010 Guillaume Pellerin <pellerin@parisson.com>
-# All rights reserved.
-#
-# This software is licensed as described in the file COPYING, which
-# you should have received as part of this distribution. The terms
-# are also available at http://svn.parisson.org/deefuzzer/DeeFuzzLicense.
-#
-# Author: Guillaume Pellerin <pellerin@parisson.com>
-
-
-Dependencies
-=============
-
-depends: python, python-dev, python-xml, python-shout | shout-python, libshout3,
- libshout3-dev, python-mutagen
-
-provides: shout-python | python-shout, python-tinyurl
-
-optional: python-twitter, python-liblo | pyliblo (>= 0.26)
-
-recommends: icecast2, python-setuptools
-
-
-Install
-=========
-
-Please first install libshout3 and liblo from source OR libshout3-dev and liblo-dev from your own distribution package manager.
-
-Now, the easiest way to install the DeeFuzzer from a shell::
-
- sudo pip install deefuzzer
-
-or::
-
- sudo easy_install install deefuzzer
-
-To install the DeeFuzzer from sources, go to the main deefuzzer app directory, for example::
-
- cd deefuzzer-0.5.0
-
-and run::
-
- sudo python setup.py install
-
-For more informations, see http://svn.parisson.org/deefuzzer/
-
-
-Twitter (manual and optional)
-================================
-
-To get track twitting, please install python-twitter, python-oauth2 and all their dependencies.
-
-Install python-oauth2::
-
- sudo easy_install oauth2
-
-Get and install python-twitter (>= 0.8.1)::
-
- wget http://python-twitter.googlecode.com/files/python-twitter-0.8.1.tar.gz
- tar xzf python-twitter-0.8.1.tar.gz
- cd python-twitter-0.8.1
- sudo python setup.py install
-
-As Twitter access requires oauth keys since 07/2010, you need to get your own access token key pair.
-Please run the dedicated script to do this from the main deefuzzer app directory::
-
- 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 :)
-
--- /dev/null
+
+Introduction
+============
+
+DeeFuzzer is a free, light and instant software made for streaming audio and video over internet.
+It is dedicated to people who wants to create playlisted web radios or web TVs with rich media contents including some metadata.
+
+Here are the main features of the deefuzzer:
+
+ * MP3 and OGG (audio & video) file streaming over internet (Icecast)
+ * Full metadata encapsulation and management
+ * RSS podcast generator (current tracks and playlists)
+ * M3U playlist generator
+ * Recursive, random (shuffled) or pre-defined playlists
+ * Multi-threaded architecture : multiple station streaming with one config file
+ * Auto Twitter posting of the current playing and new tracks
+ * Jingling between main tracks
+ * OSC controller : control the main functions from a distant terminal
+ * Station relaying : stream other stations like *LIVE* sessions !
+ * Very light and optimized streaming process
+
+It is onlu neccessary to provide a config file which sets all needed parameters.
+Please see example/deefuzzer.xml for an example.
+
+Because our aim is to get DeeFuzzer as light as possible it is NOT capable of re-encoding or transcoding media files.
+
+Installation
+============
+
+Please first install libshout3 and liblo from source OR libshout3-dev and liblo-dev from your own distribution package manager.
+
+Now, the easiest way to install the DeeFuzzer from a shell::
+
+ sudo pip install deefuzzer
+
+or::
+
+ sudo easy_install deefuzzer
+
+To install the DeeFuzzer from sources, go to the main deefuzzer app directory, for example::
+
+ tar xzf deefuzzer-0.6.tar.gz
+ cd deefuzzer-0.6
+
+and run::
+
+ sudo python setup.py install
+
+For more informations, see http://svn.parisson.org/deefuzzer/
+
+
+License
+=======
+
+This software is licensed as described in the file LICENSE.txt, which
+you should have received as part of this distribution. The terms
+are also available at http://svn.parisson.org/deefuzzer/wiki/DeeFuzzerLicense
+
+
+Usage
+=====
+
+Usage : deefuzzer CONFIGFILE
+
+where CONFIGFILE is the path for a XML config file. For example::
+
+ deefuzzer example/deefuzzer.xml
+
+To make the deefuzzer act as a deamon, just play it in the background::
+
+ deefuzzer example/deefuzzer.xml &
+
+Note that you must edit the config file with right parameters before playing.
+You can find an example for a draft XML file in the directory "example/" of this
+application (maybe in /usr/share/deefuzzer/example/ if installed with the help of install.py)
+
+Since 0.3, deefuzzer doesn't print anything into the shell, then a right <log> parameter
+is needed in the XML config file.
+
+BE CAREFULL : at the moment, the multi-threaded implementation of deefuzzer instances
+avoids shutting down the process with a CTRL+C. You have to kill them manually,
+after a CTRL+Z, making this::
+
+ pkill -9 deefuzzer
+
+
+XML Configuration
+=================
+
+See example/deefuzz_doc.xml in a text editor.
+The inline comments should help you to configure your stations.
+
+For a short MP3 example, see example/deefuzzer.xml.
+For a mixed MP3 + OGG example, see example/deefuzzer_mp3_ogg.xml.
+
+
+OSC Control
+===========
+
+We can now control some functions of the deefuzzer with external commands
+coming from an OSC client. These are accessible only if the <control><mode> tag is
+set up to "1" in the config file (see example/deefuzzer.xml again...).
+
+Next track::
+
+ python deefuzzer/scripts/osc_next.py
+
+Start twitting::
+
+ python deefuzzer/scripts/osc_twitter_start.py
+
+Stop twitting::
+
+ python deefuzzer/scripts/osc_twitter_stop.py
+
+Start relaying::
+
+ python deefuzzer/scripts/osc_relay_start.py
+
+Stop relaying::
+
+ python deefuzzer/scripts/osc_relay_stop.py
+
+Start jingling::
+
+ python deefuzzer/scripts/osc_jingles_start.py
+
+Stop jingling::
+
+ python deefuzzer/scripts/osc_jingles_stop.py
+
+
+Author
+======
+
+Guillaume Pellerin <yomguy@parisson.com>
+
+
+Aknowledgements
+===============
+
+This work is inspired by the great - C coded - Oddsock's streaming program : Ezstream.
+Since I needed to patch it in order to modify the playlist (randomize for example)
+and make external batch tools to create multiple channels, I decided to rewrite it
+from scratch in python.
+
+Some parts of this work are also taken from another Parisson's project : Telemeta
+(see http://telemeta.org).
+
+
+Contact / Infos
+===============
+
+see http://svn.parisson.org/deefuzzer/ or http://parisson.com for more info.
+
+++ /dev/null
-
-Introduction
-============
-
-DeeFuzzer is a free, light and instant software made for streaming audio and video over internet.
-It is dedicated to people who wants to create playlisted web radios or web TVs with rich media contents including some metadata.
-
-Here are the main features of the deefuzzer:
-
- * MP3 and OGG (audio & video) file streaming over internet (Icecast)
- * Full metadata encapsulation and management
- * RSS podcast generator (current tracks and playlists)
- * M3U playlist generator
- * Recursive, random (shuffled) or pre-defined playlists
- * Multi-threaded architecture : multiple station streaming with one config file
- * Auto Twitter posting of the current playing and new tracks
- * Jingling between main tracks
- * OSC controller : control the main functions from a distant terminal
- * Station relaying : stream other stations like *LIVE* sessions !
- * Very light and optimized streaming process
-
-It is onlu neccessary to provide a config file which sets all needed parameters.
-Please see example/deefuzzer.xml for an example.
-
-Because our aim is to get DeeFuzzer as light as possible it is NOT capable of re-encoding or transcoding media files.
-
-Installation
-============
-
-Please first install libshout3 and liblo from source OR libshout3-dev and liblo-dev from your own distribution package manager.
-
-Now, the easiest way to install the DeeFuzzer from a shell::
-
- sudo pip install deefuzzer
-
-or::
-
- sudo easy_install deefuzzer
-
-To install the DeeFuzzer from sources, go to the main deefuzzer app directory, for example::
-
- tar xzf deefuzzer-0.6.tar.gz
- cd deefuzzer-0.6
-
-and run::
-
- sudo python setup.py install
-
-For more informations, see http://svn.parisson.org/deefuzzer/
-
-
-License
-=======
-
-This software is licensed as described in the file LICENSE.txt, which
-you should have received as part of this distribution. The terms
-are also available at http://svn.parisson.org/deefuzzer/wiki/DeeFuzzerLicense
-
-
-Usage
-=====
-
-Usage : deefuzzer CONFIGFILE
-
-where CONFIGFILE is the path for a XML config file. For example::
-
- deefuzzer example/deefuzzer.xml
-
-To make the deefuzzer act as a deamon, just play it in the background::
-
- deefuzzer example/deefuzzer.xml &
-
-Note that you must edit the config file with right parameters before playing.
-You can find an example for a draft XML file in the directory "example/" of this
-application (maybe in /usr/share/deefuzzer/example/ if installed with the help of install.py)
-
-Since 0.3, deefuzzer doesn't print anything into the shell, then a right <log> parameter
-is needed in the XML config file.
-
-BE CAREFULL : at the moment, the multi-threaded implementation of deefuzzer instances
-avoids shutting down the process with a CTRL+C. You have to kill them manually,
-after a CTRL+Z, making this::
-
- pkill -9 deefuzzer
-
-
-XML Configuration
-=================
-
-See example/deefuzz_doc.xml in a text editor.
-The inline comments should help you to configure your stations.
-
-For a short MP3 example, see example/deefuzzer.xml.
-For a mixed MP3 + OGG example, see example/deefuzzer_mp3_ogg.xml.
-
-
-OSC Control
-===========
-
-We can now control some functions of the deefuzzer with external commands
-coming from an OSC client. These are accessible only if the <control><mode> tag is
-set up to "1" in the config file (see example/deefuzzer.xml again...).
-
-Next track::
-
- python deefuzzer/scripts/osc_next.py
-
-Start twitting::
-
- python deefuzzer/scripts/osc_twitter_start.py
-
-Stop twitting::
-
- python deefuzzer/scripts/osc_twitter_stop.py
-
-Start relaying::
-
- python deefuzzer/scripts/osc_relay_start.py
-
-Stop relaying::
-
- python deefuzzer/scripts/osc_relay_stop.py
-
-Start jingling::
-
- python deefuzzer/scripts/osc_jingles_start.py
-
-Stop jingling::
-
- python deefuzzer/scripts/osc_jingles_stop.py
-
-
-Author
-======
-
-Guillaume Pellerin <yomguy@parisson.com>
-
-
-Aknowledgements
-===============
-
-This work is inspired by the great - C coded - Oddsock's streaming program : Ezstream.
-Since I needed to patch it in order to modify the playlist (randomize for example)
-and make external batch tools to create multiple channels, I decided to rewrite it
-from scratch in python.
-
-Some parts of this work are also taken from another Parisson's project : Telemeta
-(see http://telemeta.org).
-
-
-Contact / Infos
-===============
-
-see http://svn.parisson.org/deefuzzer/ or http://parisson.com for more info.
-
include_package_data = True,
scripts=['scripts/deefuzzer'],
classifiers = ['Programming Language :: Python', 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 'Topic :: Multimedia :: Sound/Audio', 'Topic :: Multimedia :: Sound/Audio :: Players',],
- long_description=open('README.txt').read(),
+ long_description=open('README.rst').read(),
)
def Main():
projects / deefuzzer.git / commitdiff