display whats new

Author: sudormrfbin

CHANGELOG.md

@@ -8,7 +8,9 @@ v0.7.0
 - [x] Added option for smooth scroll
 - [x] Preferences are now saved when updating the app
 - [x] Validators for smooth_scroll and preview_format
-- [ ] Display a "What's New" Popup when app is run after an update
+- [x] Display a "What's New" Popup when app is run after an update
+
+- - -
 
 v0.6.2
 ------

clid/NEW.txt

@@ -0,0 +1,9 @@
+v0.7.0
+------
+
+- Vi keybindings
+- Added option for smooth scroll
+- Preferences are now saved when updating the app
+- Validators for smooth_scroll and preview_format
+- Display a "What's New" Popup when app is run after an update
+

clid/main.py

@@ -13,6 +13,7 @@
 from . import database
 from . import editmeta
 
+CONFIG_DIR = os.path.expanduser('~/.config/clid/')
 
 class MainActionController(base.ClidActionController):
     """Object that recieves recieves inpout in command line
@@ -175,6 +176,18 @@ def __init__(self, *args, **kwargs):
         self.after_search_now_filter_view = False
         # used to revert screen(ESC) to standard view after a search(see class ClidMultiline)
 
+        with open(CONFIG_DIR + 'first', 'r') as file:
+            first = file.read()
+
+        if first == 'true':
+            # if app is run for first time or after an update, display a what's new message
+            with open(CONFIG_DIR + 'NEW') as new:
+                display = new.read()
+            npy.notify_confirm(message=display, title='What\'s New', editw=1, wide=True)
+            with open(CONFIG_DIR + 'first', 'w') as file:
+                file.write('false')
+
+
     # change to `load_pref`
     def load_files(self):
         """Set the mp3 files that will be displayed"""
@@ -193,7 +206,7 @@ class ClidApp(npy.NPSAppManaged):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.current_file = None   # changed when a file is selected in main screen
-        self.settings = configobj.ConfigObj(os.path.expanduser('~/.clid.ini'))
+        self.settings = configobj.ConfigObj(CONFIG_DIR + 'clid.ini')
 
     def onStart(self):
         npy.setTheme(npy.Themes.ElegantTheme)

gen_whats_new.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+
+"""Script for generating a what's file in ./clid/"""
+
+with open('CHANGELOG.md', 'r') as log:
+    lines = log.readlines()
+    new = lines[lines.index('\n') + 1: lines.index('- - -\n')]
+
+temp = []
+for line in new:
+    if line.startswith('- '):
+        temp.append('- ' + line[6:])
+    else:
+        temp.append(line)
+
+with open('clid/NEW.txt', 'w') as file:
+    file.writelines(temp)

setup.py

@@ -12,6 +12,7 @@
 
 home = os.path.expanduser('~')
 here = os.path.dirname(os.path.abspath(__file__))
+config_dir = home + '/.config/clid'
 
 long_des = """Clid is a command line app written in Python3 to manage your mp3 files' ID3 tags.
 Unlike other tools, clid provides a graphical interface in the terminal to edit
@@ -21,21 +22,39 @@
 See the `homepage <https://github.com/GokulSoumya/clid>`_ for more details.
 """
 
+def set_up_pref_file():
+    import configobj
+    try:
+        os.makedirs(config_dir)
+    except FileExistsError:
+        pass
+
+    default = configobj.ConfigObj(here + '/clid/config.ini')   # get the ini file with default settings
+    try:
+        # get user's config file if app is already installed
+        user = configobj.ConfigObj(config_dir + '/clid.ini', file_error=True)
+    except OSError:
+        # expand `~/Music` if app is being installed for the first time
+        user = configobj.ConfigObj(config_dir + '/clid.ini')
+        user['music_dir'] = home + '/Music/'
+
+    default.update(user)   # save user's settings and add new settings options
+    default.write(outfile=open(config_dir + '/clid.ini', 'wb'))   # will raise error if outfile is filename
+
+def make_whats_new():
+    with open(here + '/clid/NEW.txt', 'r') as file:
+        to_write = file.read()
+    with open(config_dir +'/NEW', 'w') as file:
+        file.write(to_write)
+
+
 class PostInstall(install):
     def run(self):
-        import configobj
-
-        default = configobj.ConfigObj(here + '/clid/config.ini')   # get the ini file with default settings
-        try:
-            # get user's config file if app is already installed
-            user = configobj.ConfigObj(home + '/.clid.ini', file_error=True)
-        except OSError:
-            # expand `~/Music` if app is being installed for the first time
-            user = configobj.ConfigObj(home + '/.clid.ini')
-            user['music_dir'] = home + '/Music/'
-
-        default.update(user)   # save user's settings and add new settings options
-        default.write(outfile=open(home + '/.clid.ini', 'wb'))   # will raise error if outfile is filename
+        set_up_pref_file()
+        make_whats_new()
+        with open(config_dir + '/first', 'w') as file:
+            # used to display What's New popup(if true)
+            file.write('true')
 
         install.run(self)