- updating docs

- build_install_pyradio will be more strict in checking before deleting
  installation folder

Author: s-n-g

Changelog

@@ -1,3 +1,10 @@
+2021-03-23 s-n-g
+    * Implemented a simplified method to install, update, uninstall.
+    * PyRadio will detect its player abnormal termination.
+    * Player's connection timeout can now be disabled. Once a player is
+      started, it will be considered to be connected immediately.
+    * Active players parameter list is always synchronized to saved.
+
 2021-02-27 s-n-g
     * Version 0.8.8.5 (BUG FIX release)
     * Fixing -ap value not activated by player

README.html

@@ -57,6 +57,7 @@ <h2 id="table-of-contents">Table of contents <span style="padding-left: 10px;"><
 <li><a href="#cleaning-up">Cleaning up</a></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="#todo">TODO</a></li>
 <li><a href="#acknowlegement">Acknowlegement</a></li>
 </ul>
@@ -550,6 +551,19 @@ <h2 id="reporting-bugs">Reporting bugs <span style="padding-left: 10px;"><sup st
 $ pyradio -d</pre>
 <p>Then try to reproduce the bug and exit <strong>pyradio</strong>.</p>
 <p>Finally, include the file produced in your report.</p>
+<h2 id="packaging-pyradio">Packaging Pyradio <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>If you are a packager and would like to produce a package for your distribution please do follow this mini guide.</p>
+<p><strong>PyRadio</strong> is able to update and uninstall itself, when installed from sources.</p>
+<p>This is something you do not want to be available when your package is used; <strong>PyRadio</strong> should be updated and uninstalled using the distro package manager.</p>
+<p>In order to accomplice that, you just have to change the <strong>distro</strong> configuration parameter in the <strong>config</strong> file.</p>
+<p><strong>PyRadio</strong> will read this parameter and will disable updating and uninstalling, when set to anything other than “<strong>None</strong>”.</p>
+<p>So, here’s how you do that:</p>
+<p>Once you are in the sources top level directory (typically “<em>pyradio</em>”), you execute the command:</p>
+<pre>sed -i &#39;s/distro = None/distro = YOUR DISTRO NAME&#39; pyradio/config</pre>
+<p>Then you go on to produce the package as you would normally do.</p>
+<p>For example, an <strong>Arch Linux</strong> packager would use this command:</p>
+<pre>sed -i &#39;s/distro = None/distro = Arch Linux&#39; pyradio/config</pre>
+<p>The distro name you insert here will appear in <strong>PyRadio</strong>’s log file, so that I know where the package came from while debugging, so if you are not packaging for a specific distribution, please do use something meaningful (for example, using “<em>xxx</em>” will do the job, but provides no useful information).</p>
 <h2 id="todo">TODO <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 class="task-list">
 <li><input type="checkbox" disabled="" />

README.md

@@ -29,6 +29,7 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
 * [Cleaning up](#cleaning-up)
 * [Debug mode](#debug-mode)
 * [Reporting bugs](#reporting-bugs)
+* [Packagin PyRadio](#packaging-pyradio)
 * [TODO](#todo)
 * [Acknowlegement](#acknowlegement)
 
@@ -742,6 +743,36 @@ Then try to reproduce the bug and exit **pyradio**.
 
 Finally, include the file produced in your report.
 
+## Packaging Pyradio
+
+If you are a packager and would like to produce a package for your distribution please do follow this mini guide.
+
+**PyRadio** is able to update and uninstall itself, when installed from sources.
+
+This is something you do not want to be available when your package is used; **PyRadio** should be updated and uninstalled using the distro package manager.
+
+In order to accomplice that, you just have to change the **distro** configuration parameter in the **config** file.
+
+**PyRadio** will read this parameter and will disable updating and uninstalling, when set to anything other than "**None**".
+
+So, here's how you do that:
+
+Once you are in the sources top level directory (typically "*pyradio*"), you execute the command:
+
+```
+sed -i 's/distro = None/distro = YOUR DISTRO NAME' pyradio/config
+```
+
+Then you go on to produce the package as you would normally do.
+
+For example, an **Arch Linux** packager would use this command:
+
+```
+sed -i 's/distro = None/distro = Arch Linux' pyradio/config
+```
+
+The distro name you insert here will appear in **PyRadio**'s log file, so that I know where the package came from while debugging, so if you are not packaging for a specific distribution, please do use something meaningful (for example, using "*xxx*" will do the job, but provides no useful information).
+
 ## TODO
 
 - [ ] Any user request I find interesting :)

build.html

@@ -42,11 +42,7 @@ <h2 id="table-of-contents">Table of contents <span style="padding-left: 10px;"><
 <li><a href="#macos">macOS</a></li>
 <li><a href="windows.html">Windows</a></li>
 </ul></li>
-<li><a href="#performing-the-installation">Performing the installation</a>
-<ul>
-<li><a href="#development-version">Development version</a></li>
-<li><a href="#stable-version">Stable version</a></li>
-</ul></li>
+<li><a href="#performing-the-installation">Performing the installation</a></li>
 </ul></li>
 <li><a href="README.html">Return to main doc</a></li>
 </ul>
@@ -56,21 +52,23 @@ <h2 id="building-from-source">Building from source <span style="padding-left: 10
 <li>A pre-built package is not available to you.</li>
 <li>You want to use a particular python version. For example, most pre-built packages nowadays are built using python 3.x. If for any reason you have to use python 2.x, this is the way to go.</li>
 </ul>
-<p>For the installation you will need <strong><em>git</em></strong>, <strong><em>setuptools</em></strong> (e.g. <em>python-setuptools</em>, <em>python3-setuptools</em> or <em>python2-setuptools</em>) and <strong><em>requests</em></strong> (e.g. <em>python-requests</em>, <em>python3-requests</em> or <em>python2-requests</em>) to be already installed.</p>
-<p>Finally, you will use the <strong><em>build_install_pyradio</em></strong> script, located int the <strong><em>devel</em></strong> directory.</p>
-<p>To see your options, execute:</p>
-<pre>devel/build_install_pyradio -h</pre>
+<p>For the installation you will need:</p>
+<ol type="1">
+<li><strong><em>setuptools</em></strong> (e.g. <em>python-setuptools</em>, <em>python3-setuptools</em> or <em>python2-setuptools</em>)</li>
+<li><strong><em>requests</em></strong> (e.g. <em>python-requests</em>, <em>python3-requests</em> or <em>python2-requests</em>) to be already installed.</li>
+</ol>
+<p>The procedure presented here will not provide you with the sources; it will download and install them and then delete them. If you have to have <strong>PyRadio</strong>’s sources, you can just:</p>
+<pre>git clone https://github.com/coderholic/pyradio.git</pre>
+<p>or download a zip from <strong>PyRadio</strong>’s <a target="_blank" href="https://github.com/coderholic/pyradio">main page</a>.</p>
 <h2 id="preparing-for-the-installation">Preparing for 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>Before installing <strong>PyRadio</strong> you have to prepare your system, so that you end up with a working installation. The process depends on the OS you are on.</p>
 <h3 id="linux">Linux</h3>
-<p>Use your distribution method to install <em>python-setuptools</em>, <em>python-requests</em>, <em>git</em>, <em>sed</em> and any one of <em>MPV</em>, <em>MPlayer</em> and/or <em>VLC</em>.</p>
+<p>Use your distribution method to install <em>python-setuptools</em>, <em>python-requests</em>, <em>sed</em> and any one of <em>MPV</em>, <em>MPlayer</em> and/or <em>VLC</em>.</p>
 <p>When you are done, proceed to “<a href="#performing-the-installation">Performing the installation</a>”.</p>
 <h3 id="macos">macOS</h3>
 <p>Everything you need to install, run and keep <strong>pyradio</strong> up-to-date is available on <a target="_blank" href="https://github.com/Homebrew/homebrew">Homebrew</a>. If you haven’t already downloaded its client, go ahead and do it.</p>
 <p>Open a <strong>terminal</strong> and type:</p>
 <pre>/usr/bin/ruby -e &quot;$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)&quot;</pre>
-<p>Then just install <strong>git</strong>:</p>
-<pre>brew install git</pre>
 <p>Depending on your Mac OS version, you may have to install <strong>sed</strong> too:</p>
 <pre>brew install gnu-sed --default-names</pre>
 <p>Now it’s time to install a media player. You are free to install any one of them or even more than one…</p>
@@ -89,24 +87,18 @@ <h3 id="macos">macOS</h3>
 sudo ln -s /usr/local/bin/vlc /usr/local/bin/cvlc</pre>
 <p>Your system is ready now for <strong>pyradio</strong> to be installed. You can follow the instructions given at “<a href="#performing-the-installation">Performing the installation</a>”.</p>
 <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 source. Open a <strong>terminal</strong> and type:</p>
-<pre>git clone https://github.com/coderholic/pyradio.git
-cd pyradio</pre>
-<p>Then you have to decide to either build the development version or one of the available stable versions.</p>
-<h3 id="development-version">Development version</h3>
-<pre>devel/build_install_pyradio</pre>
-<h3 id="stable-version">Stable version</h3>
-<p>Get tag information.</p>
-<pre>git fetch --all --tags --prune
-git tag</pre>
-<p>This will report to you something similar to:</p>
-<pre>0.1
-0.4
-0.6.0</pre>
-<p>Now is the time to pick a version.</p>
-<p>For this example we will go with v. <strong>0.6.0</strong>.</p>
-<pre>git checkout tags/0.6.0 -b 0.6.0</pre>
-<p>Finally, build and install</p>
-<pre>devel/build_install_pyradio</pre>
+<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>
+<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>
+<p>Finally, execute the command:</p>
+<pre>python install.py</pre>
+<p>On <strong>Debian</strong> based systems you will have to execute:</p>
+<pre>python3 install.py</pre>
+<p>If for some reason you want a <strong>python 2</strong> installation, execute:</p>
+<pre>python2 install.py</pre>
 </body>
 </html>

build.md

@@ -12,8 +12,6 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
         * [macOS](#macos)
         * [Windows](windows.md)
     * [Performing the installation](#performing-the-installation)
-        * [Development version](#development-version)
-        * [Stable version](#stable-version)
 * [Return to main doc](README.md)
 
 ## Building from source
@@ -23,28 +21,31 @@ Reasons to build from source
 * A pre-built package is not available to you.
 * You want to use a particular python version. For example, most pre-built packages nowadays are built using python 3.x. If for any reason you have to use python 2.x, this is the way to go.
 
-For the installation you will need ***git***, ***setuptools*** (e.g. *python-setuptools*, *python3-setuptools* or *python2-setuptools*) and ***requests*** (e.g. *python-requests*, *python3-requests* or *python2-requests*) to be already installed.
+For the installation you will need:
 
-Finally, you will use the ***build_install_pyradio*** script, located int the ***devel*** directory.
+1.  ***setuptools*** (e.g. *python-setuptools*, *python3-setuptools* or *python2-setuptools*)
+ 2. ***requests*** (e.g. *python-requests*, *python3-requests* or *python2-requests*) to be already installed.
 
-To see your options, execute:
+The procedure presented here will not provide you with the sources; it will download and install them and then delete them.  If you have to have **PyRadio**'s sources, you can just:
 
 ```
-devel/build_install_pyradio -h
+git clone https://github.com/coderholic/pyradio.git
 ```
 
+or download a zip from **PyRadio**'s [main page](https://github.com/coderholic/pyradio).
+
 ## Preparing for the installation
 
 Before installing **PyRadio** you have to prepare your system, so that you end up with a working installation. The process depends on the OS you are on.
 
 ### Linux
 
-Use your distribution method to install *python-setuptools*, *python-requests*, *git*, *sed* and any one of *MPV*, *MPlayer* and/or *VLC*.
+Use your distribution method to install *python-setuptools*, *python-requests*, *sed* and any one of *MPV*, *MPlayer* and/or *VLC*.
 
 When you are done, proceed to  "[Performing the installation](#performing-the-installation)".
 
 
-### macOS 
+### macOS
 
 Everything you need to install, run and keep **pyradio** up-to-date is available on [Homebrew](https://github.com/Homebrew/homebrew). If you haven't already downloaded its client, go ahead and do it.
 
@@ -54,12 +55,6 @@ Open a **terminal** and type:
 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 ```
 
-Then just install **git**:
-
-```
-brew install git
-```
-
 Depending on your Mac OS version, you may have to install **sed** too:
 
 ```
@@ -107,49 +102,37 @@ Your system is ready now for **pyradio** to be installed. You can follow the ins
 
 ## Performing the installation
 
-First thing you do is get the source. Open a **terminal** and type:
+First thing you do is get the installation script. Open a **terminal** and type:
 
 ```
-git clone https://github.com/coderholic/pyradio.git
-cd pyradio
+cd
+wget https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py
 ```
 
-Then you have to decide to either build the development version or one of the available stable versions.
-
-### Development version
+or using curl:
 
 ```
-devel/build_install_pyradio
+cd
+curl -L https://raw.githubusercontent.com/coderholic/pyradio/devel/pyradio/install.py -o install.py
 ```
 
-### Stable version
-
-Get tag information.
-
-```
-git fetch --all --tags --prune
-git tag
-```
+**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.
 
-This will report to you something similar to:
+Finally, execute the command:
 
 ```
-0.1
-0.4
-0.6.0
+python install.py
 ```
 
-Now is the time to pick a version.
-
-For this example we will go with v. **0.6.0**.
+On **Debian** based systems you will have to execute:
 
 ```
-git checkout tags/0.6.0 -b 0.6.0
+python3 install.py
 ```
 
-Finally, build and install
+If for some reason you want a **python 2** installation, execute:
 
 ```
-devel/build_install_pyradio
+python2 install.py
 ```
 

devel/build_install_pyradio

@@ -326,4 +326,14 @@ python"${TO_PYTHON}" setup.py build && {
     #git checkout pyradio/radio.py
 }
 rm sed.$$ 2>/dev/null
-[ -z "$REMOVE_DIR" ] || [[ $REMOVE_DIR == *pyradio ]] && sudo rm -fr "$REMOVE_DIR"
+
+# remove instasllation directory
+if [ ! -z "$REMOVE_DIR" ];then
+    if [ "$REMOVE_DIR" = "$HOME/pyradio" ] || \
+            [ "$REMOVE_DIR" = "$HOME/tmp-pyradio" ] || \
+            [ "$REMOVE_DIR" = "/tmp/pyradio" ] || \
+            [ "$REMOVE_DIR" = "/tmp/tmp-pyradio" ];then
+        sudo rm -fr "$REMOVE_DIR"
+    fi
+fi
+

pyradio/config.py

@@ -1335,7 +1335,7 @@ def _get_lock_file(self):
             if platform == 'win32':
                 self._session_lock_file = path.join(getenv('APPDATA'), 'pyradio', 'pyradio.lock')
             else:
-                self._session_lock_file = path.join(getenv('HOME'), '.config', 'pyradio')
+                self._session_lock_file = path.join(getenv('HOME'), '.config', 'pyradio', 'pyradio.lock')
         if path.exists(self._session_lock_file):
             if platform == 'win32':
                 win_lock = path.join(getenv('APPDATA'), 'pyradio', '_windows.lock')
@@ -1475,6 +1475,8 @@ def read_config(self):
                            'vlc_parameter'):
                 self._config_to_params(sp)
             elif sp[0] == 'distro':
+                ''' mark as dirty to force saving config to remove setting '''
+                self.dirty_config = True
                 self._distro = sp[1].strip()
 
         ''' read distro from package config file '''
@@ -1490,7 +1492,7 @@ def read_config(self):
                     self._distro = sp[1].strip()
                     # print('Package distro is "{}"'.format(self._distro))
         except:
-            pass
+            self._distro = 'None'
 
         ''' make sure extra params have only up to 10 items each
         (well, actually 11 items, since the first one is the