starting theming

Author: s-n-g

Changelog

@@ -1,3 +1,11 @@
+2019-02-22  s-n-g
+
+	* Theme support added (4 hardcoded themes)
+	* Command line option -t (--theme) THEME added
+	* Config option "theme" added
+	* Key "T" will toggle transparency / use terminal's background color
+	* Alt keyboard combinations will not be considered as ESCAPE char
+
 2019-02-10  s-n-g
 
 	* Version 0.7.1

README.html

@@ -39,6 +39,7 @@ <h2 id="table-of-contents">Table of contents</h2>
 <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="#player-default-volume-level">Player default volume level</a></li>
+<li><a href="#pyradio-themes">PyRadio Themes</a></li>
 <li><a href="#debug-mode">Debug mode</a></li>
 </ul>
 <h2 id="requirements">Requirements</h2>
@@ -54,7 +55,7 @@ <h2 id="command-line-options">Command line options</h2>
 <pre>$ pyradio -h
 
 usage: pyradio [-h] [-s STATIONS] [-p [PLAY]] [-u USE_PLAYER] [-a] [-ls] [-l]
-               [-scd] [-ocd] [-d]
+               [-t THEME] [-scd] [-ocd] [-d]
 
 Curses based Internet radio player
 
@@ -70,8 +71,11 @@ <h2 id="command-line-options">Command line options</h2>
                         used to specify detection order. Supported players:
                         mpv, mplayer, vlc.
   -a, --add             Add station to list.
-  -ls, --list-playlists List of available playlists in config dir.
+  -ls, --list-playlists
+                        List of available playlists in config dir.
   -l, --list            List of available stations in a playlist.
+  -t THEME, --theme THEME
+                        Use specified theme.
   -scd, --show-config-dir
                         Print config directory location and exit.
   -ocd, --open-config-dir
@@ -82,6 +86,7 @@ <h2 id="command-line-options">Command line options</h2>
 <li><strong>-s</strong> - parameter <strong>default_playlist</strong> (default value: <strong>stations</strong>)</li>
 <li><strong>-p</strong> - parameter <strong>default_station</strong> (default value: <strong>-1</strong>)</li>
 <li><strong>-u</strong> - parameter <strong>player</strong> (default value: <strong>mpv, mplayer, vlc</strong>)</li>
+<li><strong>-t</strong> - parameter <strong>theme</strong> (default value: <strong>dark</strong>)</li>
 </ul>
 <h2 id="controls">Controls</h2>
 <pre>Up/Down/j/k/PgUp/PgDown   Change station selection.
@@ -95,6 +100,7 @@ <h2 id="controls">Controls</h2>
 v                         Save volume (not applicable for vlc).
 o s R                     Open / Save / Reload playlist.
 DEL,x                     Delete selected station.
+t T                       Load theme / Toggle transparency.
 ?                         Show keys help.
 Esc/q                     Quit.</pre>
 <h2 id="config-file">Config file</h2>
@@ -212,6 +218,14 @@ <h3 id="mplayer">MPlayer</h3>
 [pyradio]
 volstep=1
 volume=28</pre>
+<h2 id="pyradio-themes">PyRadio Themes</h2>
+<p><strong>PyRadio</strong> comes with 4 preconfigured (hardcoded) themes:</p>
+<ol type="1">
+<li><strong>dark</strong> (8 color theme). This is the appearance <strong>PyRadio</strong> has always had. Enabled by default.</li>
+<li><strong>light</strong> (8 color thmem). A theme for light terminal background settings.</li>
+<li><strong>white_on_black</strong> or <strong>wob</strong> (256 color b&amp;w theme). A theme for dark terminal background settings.</li>
+<li><strong>black_on_white</strong> or <strong>bow</strong> (256 color b&amp;w theme). A theme for light terminal background settings.</li>
+</ol>
 <h2 id="debug-mode">Debug mode</h2>
 <p>Adding the <strong><em>-d</em></strong> option to the command line will instruct <strong>PyRadio</strong> to enter <em>Debug mode</em>, which means that it will print debug messages to a file. This file will always reside in the user’s home directory and will be named <em>pyradio.log</em>.</p>
 <p>In case of a bug or a glitch, please include this file to the issue you will <a href="https://github.com/coderholic/pyradio/issues">open in github</a>.</p>

README.md

@@ -15,6 +15,7 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
 * [Specifying stations' encoding](#specifying-stations-encoding)
 * [Player detection / selection](#player-detection-selection)
 * [Player default volume level](#player-default-volume-level)
+* [PyRadio Themes](#pyradio-themes)
 * [Debug mode](#debug-mode)
 
 ## Requirements
@@ -35,7 +36,7 @@ In any other case, and since **PyRadio** is currently not available via pip, you
 $ pyradio -h
 
 usage: pyradio [-h] [-s STATIONS] [-p [PLAY]] [-u USE_PLAYER] [-a] [-ls] [-l]
-               [-scd] [-ocd] [-d]
+               [-t THEME] [-scd] [-ocd] [-d]
 
 Curses based Internet radio player
 
@@ -51,8 +52,11 @@ optional arguments:
                         used to specify detection order. Supported players:
                         mpv, mplayer, vlc.
   -a, --add             Add station to list.
-  -ls, --list-playlists List of available playlists in config dir.
+  -ls, --list-playlists
+                        List of available playlists in config dir.
   -l, --list            List of available stations in a playlist.
+  -t THEME, --theme THEME
+                        Use specified theme.
   -scd, --show-config-dir
                         Print config directory location and exit.
   -ocd, --open-config-dir
@@ -65,6 +69,7 @@ The following options can also be set in **PyRadio**'s [configuration file](#con
 * **-s** - parameter **default_playlist** (default value: **stations**)
 * **-p** - parameter **default_station** (default value: **-1**)
 * **-u** - parameter **player** (default value: **mpv, mplayer, vlc**)
+* **-t** - parameter **theme** (default value: **dark**)
 
 ## Controls
 
@@ -80,6 +85,7 @@ m                         Mute.
 v                         Save volume (not applicable for vlc).
 o s R                     Open / Save / Reload playlist.
 DEL,x                     Delete selected station.
+t T                       Load theme / Toggle transparency.
 ?                         Show keys help.
 Esc/q                     Quit.
 ```
@@ -304,6 +310,15 @@ Example:
     volstep=1
     volume=28
 
+## PyRadio Themes
+
+**PyRadio** comes with 4 preconfigured (hardcoded) themes:
+
+1. **dark** (8 color theme). This is the appearance **PyRadio** has always had. Enabled by default.
+2. **light** (8 color thmem). A theme for light terminal background settings.
+3. **white_on_black** or **wob** (256 color b&w theme). A theme for dark terminal background settings.
+4. **black_on_white** or **bow** (256 color b&w theme). A theme for light terminal background settings.
+
 ## Debug mode
 
 Adding the ***-d*** option to the command line will instruct **PyRadio** to enter *Debug mode*, which means that it will print debug messages to a file. This file will always reside in the user's home directory and will be named *pyradio.log*.

pyradio/config

@@ -52,6 +52,24 @@ default_encoding = utf-8
 # Default value: 10
 connection_timeout = 10
 
+# Default theme
+# Hardcooded themes:
+#   dark (default) (8 colors)
+#   light (8 colors
+#   black_on_white (bow) (256 colors)
+#   white_on_black (wob) (256 colors)
+# Default value = 'dark'
+theme = dark
+
+# Transparency setting
+# If False, theme colors will be used.
+# If True and a compositor is running, the stations' window
+# background will be transparent. If True and a compositor is 
+# not running, the terminal's background color will be used.
+# Valid values: True, true, False, false
+# Default value: False
+use_transparency = False
+
 
 # Playlist management
 #

pyradio/config.py

@@ -8,6 +8,7 @@
 from shutil import copyfile, move
 from .log import Log
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -269,7 +270,7 @@ def save_playlist_file(self, stationFile=''):
         else:
             st_file = self.stations_file
 
-        if self.dirty_playlist is False:
+        if not self.dirty_playlist:
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('Playlist not modified...')
             return 0
@@ -415,6 +416,8 @@ def __init__(self):
         self.default_station = '-1'
         self.default_encoding = 'utf-8'
         self.connection_timeout = '10'
+        self.theme = 'dark'
+        self.use_transparency = False
 
         self.dirty_config = False
 
@@ -443,6 +446,15 @@ def player_to_use(self, val):
         self.__player_to_use = val
         self.__dirty_config = True
 
+    @property
+    def use_transparency(self):
+        return self.__use_transparency
+
+    @use_transparency.setter
+    def use_transparency(self, val):
+        self.__use_transparency = val
+        self.__dirty_config = True
+
     @property
     def default_encoding(self):
         return self.__default_encoding
@@ -506,6 +518,15 @@ def connection_timeout(self, val):
         self.__connection_timeout = val
         self.__dirty_config = True
 
+    @property
+    def theme(self):
+        return self.__theme
+
+    @theme.setter
+    def theme(self, val):
+        self.__theme = val
+        self.__dirty_config = True
+
     @property
     def dirty_config(self):
         return self.__dirty_config
@@ -515,13 +536,21 @@ def dirty_config(self, val):
         self.__dirty_config = val
 
     def _check_config_file(self, usr):
-        ''' Make sure a config file exists in the config diro '''
+        ''' Make sure a config file exists in the config dir '''
+        package_config_file = path.join(path.dirname(__file__), 'config')
+        user_config_file = path.join(usr, 'config')
 
-        config_file = path.join(path.dirname(__file__), 'config')
-        if path.exists(path.join(usr, 'config')):
-            return
-        else:
-            copyfile(config_file, path.join(usr, 'config'))
+        ''' restore config from bck file '''
+        if path.exists(user_config_file + '.restore'):
+            try:
+                copyfile(user_config_file + '.restore', user_config_file))
+                remove(self.user_config_file + '.restore')
+            except:
+                pass
+
+        ''' Copy package config into user dir '''
+        if not path.exists(user_config_file):
+            copyfile(package_config_file, user_config_file))
 
     def read_config(self):
         lines = []
@@ -544,12 +573,14 @@ def read_config(self):
                 self.__connection_timeout = sp[1].strip()
             elif sp[0] == 'default_encoding':
                 self.__default_encoding = sp[1].strip()
+            elif sp[0] == 'theme':
+                self.__theme = sp[1].strip()
             elif sp[0] == 'default_playlist':
                 self.__default_playlist = sp[1].strip()
             elif sp[0] == 'default_station':
                 st = sp[1].strip()
                 if st == '-1':
-                    self.__default_station = False
+                    self.__default_station = 'False'
                 elif st == 'random':
                     self.__default_station = None
                 else:
@@ -569,11 +600,16 @@ def read_config(self):
                     self.__auto_save_playlist = True
                 else:
                     self.__auto_save_playlist = False
+            elif sp[0] == 'use_transparency':
+                if sp[1].lower() == 'true':
+                    self.__use_transparency = True
+                else:
+                    self.__use_transparency = False
         self.__dirty_config = False
         return 0
 
     def _save_config(self):
-        if self.__dirty_config is False:
+        if not self.__dirty_config:
             if logger.isEnabledFor(logging.INFO):
                 logger.info('Config not saved (not modified)')
             return 0
@@ -634,29 +670,48 @@ def _save_config(self):
 # Default value: 10
 connection_timeout = {4}
 
+# Default theme
+# Hardcooded themes:
+#   dark (default) (8 colors)
+#   light (8 colors
+#   black_on_white (bow) (256 colors)
+#   white_on_black (wob) (256 colors)
+# Default value = 'dark'
+theme = {5}
+
+# Transparency setting
+# If False, theme colors will be used.
+# If True and a compositor is running, the stations' window
+# background will be transparent. If True and a compositor is 
+# not running, the terminal's background color will be used.
+# Valid values: True, true, False, false
+# Default value: False
+use_transparency = {6}
+
+
 # Playlist management
 #
 # Specify whether you will be asked to confirm
 # every station deletion action
 # Valid values: True, true, False, false
 # Default value: True
-confirm_station_deletion = {5}
+confirm_station_deletion = {7}
 
 # Specify whether you will be asked to confirm
 # playlist reloading, when the playlist has not
 # been modified within Pyradio
 # Valid values: True, true, False, false
 # Default value: True
-confirm_playlist_reload = {6}
+confirm_playlist_reload = {8}
 
 # Specify whether you will be asked to save a
 # modified playlist whenever it needs saving
 # Valid values: True, true, False, false
 # Default value: False
-auto_save_playlist = {7}
+auto_save_playlist = {9}
 
 '''
-        copyfile(self.config_file, self.config_file + '.bck')
+        copyfile(self.config_file, self.config_file + '.restore')
         if self.__default_station is None:
             self.__default_station = '-1'
         try:
@@ -665,7 +720,9 @@ def _save_config(self):
                     self.__default_playlist,
                     self.__default_station,
                     self.__default_encoding,
-                    self,__connection_timeout,
+                    self.__connection_timeout,
+                    self.__theme,
+                    self.__use_transparency,
                     self.__confirm_station_deletion,
                     self.__confirm_playlist_reload,
                     self.__auto_save_playlist))
@@ -674,7 +731,7 @@ def _save_config(self):
                 logger.error('Error saving config')
             return -1
         try:
-            remove(self.config_file + '.bck')
+            remove(self.config_file + '.restore')
         except:
             pass
         if logger.isEnabledFor(logging.INFO):

pyradio/edit.py

@@ -38,7 +38,7 @@ def show(self, parent_win, repaint=False):
             self._caption_win.addstr(0, x-1, u'\u2524'.encode('utf-8'), self.box_color)
         except:
             pass
-        if repaint is False:
+        if not repaint:
             self.string = ''
             self._curs_pos = 0
             self._input_history.reset_index()