updating docs and adding --devel installation option

Author: s-n-g

README.html

@@ -34,32 +34,68 @@ <h1 style="color: SaddleBrown"id="pyradio">PyRadio</h1>
 <p>Ben Dowling - <a target="_blank" href="https://github.com/coderholic">https://github.com/coderholic</a></p>
 <h2 id="table-of-contents">Table of contents <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <ul>
+<li><a href="#table-of-contents">Table of contents</a></li>
 <li><a href="#requirements">Requirements</a></li>
 <li><a href="#installation">Installation</a></li>
 <li><a href="#command-line-options">Command line options</a></li>
 <li><a href="#controls">Controls</a></li>
 <li><a href="#pyradios-modes">PyRadio’s Modes</a></li>
 <li><a href="#config-file">Config file</a></li>
-<li><a href="#about-playlist-files">About Playlist files</a></li>
+<li><a href="#about-playlist-files">About Playlist files</a>
+<ul>
+<li><a href="#specifying-a-playlist-to-load-command-line">Specifying a playlist to load (command line)</a></li>
+<li><a href="#managing-playlists-within-pyradio">Managing playlists (within PyRadio)</a></li>
+<li><a href="#managing-foreign-playlists">Managing “foreign” playlists</a></li>
+<li><a href="#playlist-history">Playlist history</a></li>
+</ul></li>
 <li><a href="#search-function">Search function</a></li>
-<li><a href="#line-editor">Line editor</a></li>
+<li><a href="#line-editor">Line editor</a>
+<ul>
+<li><a href="#cjk-characters-support">CJK characters support</a></li>
+</ul></li>
 <li><a href="#moving-stations-around">Moving stations around</a></li>
-<li><a href="#specifying-stations-encoding">Specifying stations’ encoding</a></li>
-<li><a href="#player-detection-selection">Player detection / selection</a></li>
+<li><a href="#specifying-stations-encoding">Specifying stations’ encoding</a>
+<ul>
+<li><a href="#station-by-station-encoding-declaration">Station by station encoding declaration</a></li>
+<li><a href="#global-encoding-declaration">Global encoding declaration</a></li>
+<li><a href="#finding-the-right-encoding">Finding the right encoding</a></li>
+</ul></li>
+<li><a href="#player-detection--selection">Player detection / selection</a>
+<ul>
+<li><a href="#extra-player-parameters">Extra Player Parameters</a>
+<ul>
+<li><a href="#using-the-command-line">Using the command line</a></li>
+<li><a href="#using-the-configuration-window">Using the Configuration Window</a></li>
+</ul></li>
+<li><a href="#changing-parameters-set">Changing parameters set</a></li>
+</ul></li>
 <li><a href="#player-connection-protocol">Player connection protocol</a></li>
-<li><a href="#player-default-volume-level">Player default volume level</a></li>
+<li><a href="#player-default-volume-level">Player default volume level</a>
+<ul>
+<li><a href="#mpv">MPV</a></li>
+<li><a href="#mplayer">MPlayer</a></li>
+</ul></li>
 <li><a href="#displaying-station-info">Displaying Station Info</a></li>
 <li><a href="#copying-and-pasting---registers">Copying and pasting - Registers</a></li>
-<li><a href="#pyradio-themes">PyRadio Themes</a></li>
+<li><a href="#pyradio-themes">PyRadio Themes</a>
+<ul>
+<li><a href="#using-transparency">Using transparency</a></li>
+</ul></li>
 <li><a href="#mouse-support">Mouse support</a></li>
-<li><a href="#session-locking">Session Locking</a></li>
+<li><a href="#session-locking">Session Locking</a>
+<ul>
+<li><a href="#session-unlocking">Session unlocking</a></li>
+</ul></li>
 <li><a href="#update-notification">Update notification</a></li>
-<li><a href="#cleaning-up">Cleaning up</a></li>
+<li><a href="#cleaning-up">Cleaning up</a>
+<ul>
+<li><a href="#previous-cleaning-up-procedure">Previous cleaning up procedure</a></li>
+</ul></li>
 <li><a href="#debug-mode">Debug mode</a></li>
 <li><a href="#reporting-bugs">Reporting bugs</a></li>
-<li><a href="#packaging-pyradio">Packagin PyRadio</a></li>
+<li><a href="#packaging-pyradio">Packaging Pyradio</a></li>
 <li><a href="#todo">TODO</a></li>
-<li><a href="#acknowlegement">Acknowlegement</a></li>
+<li><a href="#acknowledgment">Acknowledgment</a></li>
 </ul>
 <h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <ul>

README.md

@@ -6,32 +6,51 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
 
 ## Table of contents
 
-* [Requirements](#requirements)
-* [Installation](#installation)
-* [Command line options](#command-line-options)
-* [Controls](#controls)
-* [PyRadio's Modes](#pyradios-modes)
-* [Config file](#config-file)
-* [About Playlist files](#about-playlist-files)
-* [Search function](#search-function)
-* [Line editor](#line-editor)
-* [Moving stations around](#moving-stations-around)
-* [Specifying stations' encoding](#specifying-stations-encoding)
-* [Player detection / selection](#player-detection-selection)
-* [Player connection protocol](#player-connection-protocol)
-* [Player default volume level](#player-default-volume-level)
-* [Displaying Station Info](#displaying-station-info)
-* [Copying and pasting - Registers](#copying-and-pasting---registers)
-* [PyRadio Themes](#pyradio-themes)
-* [Mouse support](#mouse-support)
-* [Session Locking](#session-locking)
-* [Update notification](#update-notification)
-* [Cleaning up](#cleaning-up)
-* [Debug mode](#debug-mode)
-* [Reporting bugs](#reporting-bugs)
-* [Packagin PyRadio](#packaging-pyradio)
-* [TODO](#todo)
-* [Acknowlegement](#acknowlegement)
+  - [Table of contents](#table-of-contents)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Command line options](#command-line-options)
+  - [Controls](#controls)
+  - [PyRadio's Modes](#pyradios-modes)
+  - [Config file](#config-file)
+  - [About Playlist files](#about-playlist-files)
+    - [Specifying a playlist to load (command line)](#specifying-a-playlist-to-load-command-line)
+    - [Managing playlists (within PyRadio)](#managing-playlists-within-pyradio)
+    - [Managing "foreign" playlists](#managing-foreign-playlists)
+    - [Playlist history](#playlist-history)
+  - [Search function](#search-function)
+  - [Line editor](#line-editor)
+    - [CJK characters support](#cjk-characters-support)
+  - [Moving stations around](#moving-stations-around)
+  - [Specifying stations' encoding](#specifying-stations-encoding)
+    - [Station by station encoding declaration](#station-by-station-encoding-declaration)
+    - [Global encoding declaration](#global-encoding-declaration)
+    - [Finding the right encoding](#finding-the-right-encoding)
+  - [Player detection / selection](#player-detection--selection)
+    - [Extra Player Parameters](#extra-player-parameters)
+      - [Using the command line](#using-the-command-line)
+      - [Using the Configuration Window](#using-the-configuration-window)
+    - [Changing parameters set](#changing-parameters-set)
+  - [Player connection protocol](#player-connection-protocol)
+  - [Player default volume level](#player-default-volume-level)
+    - [MPV](#mpv)
+    - [MPlayer](#mplayer)
+  - [Displaying Station Info](#displaying-station-info)
+  - [Copying and pasting - Registers](#copying-and-pasting---registers)
+  - [PyRadio Themes](#pyradio-themes)
+    - [Using transparency](#using-transparency)
+  - [Mouse support](#mouse-support)
+  - [Session Locking](#session-locking)
+    - [Session unlocking](#session-unlocking)
+  - [Update notification](#update-notification)
+  - [Cleaning up](#cleaning-up)
+    - [Previous cleaning up procedure](#previous-cleaning-up-procedure)
+  - [Debug mode](#debug-mode)
+  - [Reporting bugs](#reporting-bugs)
+  - [Packaging Pyradio](#packaging-pyradio)
+  - [TODO](#todo)
+  - [Acknowledgment](#acknowledgment)
+
 
 ## Requirements
 

build.html

@@ -89,11 +89,11 @@ <h3 id="macos">macOS</h3>
 <h2 id="performing-the-installation">Performing the installation <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <p>First thing you do is get the installation script. Open a <strong>terminal</strong> and type:</p>
 <pre>cd
-wget https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py</pre>
+wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py</pre>
 <p>or using curl:</p>
 <pre>cd
-curl -L https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py -o install.py</pre>
-<p><strong>Note</strong>: If you have neither <em>wget</em> or <em>curl</em> installed, just right click on <a target="_blank" href="https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py">this link</a> and use your browser “<strong>Save as</strong>” menu entry to save the file in your home folder.</p>
+curl -L https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py -o install.py</pre>
+<p><strong>Note</strong>: If you have neither <em>wget</em> or <em>curl</em> installed, just right click on <a target="_blank" href="https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py">this link</a> and use your browser “<strong>Save link as</strong>” menu entry to save the file in your home folder.</p>
 <p>Finally, execute the command:</p>
 <pre>python install.py</pre>
 <p>On <strong>Debian</strong> based systems you will have to execute:</p>

build.md

@@ -106,17 +106,17 @@ First thing you do is get the installation script. Open a **terminal** and type:
 
 ```
 cd
-wget https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py
+wget https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py
 ```
 
 or using curl:
 
 ```
 cd
-curl -L https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py -o install.py
+curl -L https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py -o install.py
 ```
 
-**Note**: If you have neither *wget* or *curl* installed, just right click on [this link](https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py) and use your browser "**Save as**" menu entry to save the file in your home folder.
+**Note**: If you have neither *wget* or *curl* installed, just right click on [this link](https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py) and use your browser "**Save link as**" menu entry to save the file in your home folder.
 
 Finally, execute the command:
 

pyradio/install.py

@@ -49,14 +49,16 @@ class PyRadioUpdate(object):
             0   -   official release
             1   -   s-n-g release
             2   -   s-h-g devel
+            3   -   official devel
     '''
 
     ZIP_URL = ('https://github.com/coderholic/pyradio/archive/master.zip',
                 'https://github.com/s-n-g/pyradio/archive/master.zip',
                 'https://github.com/s-n-g/pyradio/archive/devel.zip',
+                'https://github.com/coderholic/pyradio/archive/devel.zip',
                 )
 
-    ZIP_DIR  = ('pyradio-master', 'pyradio-master', 'pyradio-devel')
+    ZIP_DIR  = ('pyradio-master', 'pyradio-master', 'pyradio-devel', 'pyradio-devel')
 
     install = False
     user = False
@@ -190,7 +192,7 @@ def _do_it(self, mode='update'):
             print('Error: Cannot create temp directory: "{}"'.format(self._dir))
             sys.exit(1)
 
-        ''' downloaad pyradio '''
+        ''' download pyradio '''
         self._download_pyradio()
 
         ''' change to pyradio directory '''
@@ -280,7 +282,7 @@ def _empty_dir(self):
         self._mkdir(self._dir, self._empty_dir, self._permission_error)
 
     def _permission_error(self):
-        print('Error: You don\'t have permission to create: ""\n'.format(self._dir))
+        print('Error: You don\'t have permission to create: "{}"\n'.format(self._dir))
         sys.exit(1)
 
     def _clean_up(self):
@@ -377,11 +379,13 @@ def _do_it(self, mode='update'):
     ''' extra downloads
         only use them after the developer says so,
         for debug purposes only
+            --devel         download official devel branch
             --sng-master    download developer release (master)
             --sng-devel     download developer devel branch
     '''
     parser.add_argument('--sng-master', action='store_true', help=SUPPRESS)
     parser.add_argument('--sng-devel', action='store_true', help=SUPPRESS)
+    parser.add_argument('--devel', action='store_true', help=SUPPRESS)
 
     args = parser.parse_args()
     sys.stdout.flush()
@@ -390,8 +394,10 @@ def _do_it(self, mode='update'):
     package = 0
     if args.sng_master:
         package = 1
-    if args.sng_devel:
+    elif args.sng_devel:
         package = 2
+    elif args.devel:
+        package = 3
 
     if args.uninstall:
         if platform.system().lower().startswith('win'):

pyradio/main.py

@@ -101,13 +101,15 @@ def shell():
     ''' extra downloads
         only use them after the developer says so,
         for debug purposes only
+            --devel           download official devel branch
             --sng-master      download developer release (master)
             --sng-devel       download developer devel branch
             --force-update    give a versio > than current,
                               to check update notification functionality
     '''
     parser.add_argument('--sng-master', action='store_true', help=SUPPRESS)
     parser.add_argument('--sng-devel', action='store_true', help=SUPPRESS)
+    parser.add_argument('--devel', action='store_true', help=SUPPRESS)
     parser.add_argument('--force-update', default='', help=SUPPRESS)
     args = parser.parse_args()
     sys.stdout.flush()
@@ -122,6 +124,8 @@ def shell():
                 package = 1
             elif args.sng_devel:
                 package = 2
+            elif args.devel:
+                package = 3
             if not config_already_read:
                 read_config(pyradio_config)
                 config_already_read = True

pyradio/radio.py

@@ -842,10 +842,6 @@ def run(self):
         else:
             ''' start update detection and notification thread '''
             if CAN_CHECK_FOR_UPDATES:
-                ''' if any of these files are found, no update check will occur
-                    TODO: find pyradio's script installation path under macOS
-                '''
-                distro_package = ('/usr/bin/pyradio', )
                 if self._cnf.locked:
                     if logger.isEnabledFor(logging.INFO):
                         logger.info('(detectUpdateThread): session locked. Not starting!!!')

windows.html

@@ -34,29 +34,33 @@ <h1 style="color: SaddleBrown"id="pyradio-on-windows">PyRadio on Windows</h1>
 <p>Ben Dowling - <a target="_blank" href="https://github.com/coderholic">https://github.com/coderholic</a></p>
 <h2 id="table-of-contents">Table of contents <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <ul>
+<li><a href="#pyradio-on-windows">PyRadio on Windows</a>
+<ul>
+<li><a href="#table-of-contents">Table of contents</a></li>
 <li><a href="#running-pyradio-on-windows">Running PyRadio on Windows</a></li>
 <li><a href="#how-it-all-works">How it all works</a></li>
 <li><a href="#installation">Installation</a>
 <ul>
-<li><a href="#python-installation">1. Python installation</a>
+<li><a href="#1-python-installation">1. Python installation</a>
 <ul>
-<li><a href="#installing-python">1.1 Installing Python</a></li>
-<li><a href="#verifying-the-installation">1.2 Verifying the installation</a></li>
+<li><a href="#11-installing-python">1.1 Installing Python</a></li>
+<li><a href="#12-verifying-the-installation">1.2 Verifying the installation</a></li>
 </ul></li>
-<li><a href="#player-installation">2. Player installation</a>
+<li><a href="#2-player-installation">2. Player installation</a>
 <ul>
-<li><a href="#mplayer-installation">2.1 MPlayer installation</a></li>
-<li><a href="#vlc-installation">2.2 VLC installation</a></li>
+<li><a href="#21-mplayer-installation">2.1 MPlayer installation</a></li>
+<li><a href="#22-vlc-installation">2.2 VLC installation</a></li>
 </ul></li>
-<li><a href="#pyradio-installation">3. PyRadio installation</a>
+<li><a href="#3-pyradio-installation">3. PyRadio installation</a>
 <ul>
-<li><a href="#final-steps">3.1 Final steps</a></li>
-<li><a href="#cleaning-up">3.2 Cleaning up</a></li>
+<li><a href="#31-final-steps">3.1 Final steps</a></li>
+<li><a href="#32-cleaning-up">3.2 Cleaning up</a></li>
 </ul></li>
 </ul></li>
 <li><a href="#updating-pyradio">Updating PyRadio</a></li>
 <li><a href="#uninstalling-pyradio">Uninstalling PyRadio</a></li>
-<li><a href="#reporting-bugs">Reporing bugs</a></li>
+<li><a href="#reporting-bugs">Reporting bugs</a></li>
+</ul></li>
 </ul>
 <p><a href="build.html">[Back to Build Instructions]</a> | <a href="README.html">[Back to README]</a></p>
 <h2 id="running-pyradio-on-windows">Running PyRadio on Windows <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
@@ -155,7 +159,7 @@ <h4 id="final-steps">3.1 Final steps</h4>
 </pre>
 <p>Finally, you can type <strong>pyradio</strong> and enjoy!</p>
 <p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> For your convenience, the installation batch file has tried to installed a shortcut on your Desktop. You can use it to launch <strong>PyRadio</strong> and optionally modify it (change font size, window dimensions, etc). If it’s not there, you can just copy it from the “<em>help</em>” directory of the <strong>Explorer File Manager</strong> which will open after executing <strong>pyradio -ocd</strong>.</p>
-<h3 id="cleaning-up">3.2 Cleaning up <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h3>
+<h4 id="cleaning-up">3.2 Cleaning up</h4>
 <p>After the installation is completed, there will be some files left on your system, which you may want to remove. These are:</p>
 <ol type="1">
 <li><strong>install.py</strong>: The script you originally downloaded. It should be in your home folder.</li>
@@ -174,7 +178,7 @@ <h2 id="uninstalling-pyradio">Uninstalling PyRadio <span style="padding-left: 10
 <pre>pyradio -R</pre>
 <p><strong>PyRadio</strong> create an uninstall batch file and open Windows Explorer to its location.</p>
 <p>You just double click on the batch file (called <strong>uninstall.bat</strong>) to complete the procedure.</p>
-<h3 id="reporting-bugs">Reporting bugs <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h3>
+<h2 id="reporting-bugs">Reporting bugs <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
 <p>When a bug is found, please do report it by <a target="_blank" href="https://github.com/coderholic/pyradio/issues">opening an issue at github</a>.</p>
 <p>In you report you should, at the very least, state your <strong>pyradio version</strong> and <strong>python version</strong>.</p>
 <p>It would be really useful to include <strong>%USERPROFILE%/pyradio.log</strong> in your report.</p>