talklib 3.6.4__tar.gz → 3.7.2__tar.gz

{talklib-3.6.4/src/talklib.egg-info → talklib-3.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: talklib
-Version: 3.6.4
+Version: 3.7.2
 Summary: A package to automate processing of shows/segments airing on the TL
 Author-email: Ben Weddle <ben.weddle@gmail.com>
 Maintainer-email: Ben Weddle <ben.weddle@gmail.com>
@@ -119,12 +119,12 @@ To repeat, **this package will not work without FFmpeg and FFprobe**.
 
 FFmpeg and FFprobe should be two separate binaries.
 
-The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet:
+The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet (you may need to run this in a terminal with Admin privileges):
 ````bash
 winget install Gyan.FFmpeg
 ````
 
-This should install both FFmpeg & FFprobe. After WinGet completes installation, test to ensure FFmpeg is installed:
+This should install both FFmpeg & FFprobe. After WinGet completes installation, restart your terminal and then test to ensure FFmpeg is installed:
 ````bash
 ffmpeg -version
 ````
@@ -169,7 +169,7 @@ Before we begin, a general note:
 - These are some of the reasons why we do not run `.py` files directly from WR.
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will automatically run the Python script (`.py` file).
 - Ensure the Batch & Python scripts are in the same directory.
-- A sample `.bat` file (`Example.bat`) is included in the [misc](https://github.com/Nashville-Public-Library/misc/tree/main/talklib_examples) repo. 
+- A sample `.bat` file (`Example.bat`) is included in the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc/tree/main/talklib_examples) repo (This is a private repo! Contact Shared Systems team to get access).
     - Download this file and place it in the same folder as your Python file.
     - Right-Click the file > select `Properties` > select `Unblock` so that it can be executed.
     - It is a best practice to give the `.bat` and `.py` files the same name, though it is not necessary.
@@ -258,7 +258,7 @@ required for all RSS or permalink shows
 
 required for "local" shows
 - path to the local file as such: `D:\path\to\the\show.wav`
-- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [MISC](https://github.com/talkinglibrary/misc) repo for some examples.
+- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc) repo for some examples (This is a private repo! Contact Shared Systems team to get access).
 
 `is_permalink`
 

{talklib-3.6.4 → talklib-3.7.2}/README.md

@@ -38,12 +38,12 @@ To repeat, **this package will not work without FFmpeg and FFprobe**.
 
 FFmpeg and FFprobe should be two separate binaries.
 
-The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet:
+The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet (you may need to run this in a terminal with Admin privileges):
 ````bash
 winget install Gyan.FFmpeg
 ````
 
-This should install both FFmpeg & FFprobe. After WinGet completes installation, test to ensure FFmpeg is installed:
+This should install both FFmpeg & FFprobe. After WinGet completes installation, restart your terminal and then test to ensure FFmpeg is installed:
 ````bash
 ffmpeg -version
 ````
@@ -88,7 +88,7 @@ Before we begin, a general note:
 - These are some of the reasons why we do not run `.py` files directly from WR.
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will automatically run the Python script (`.py` file).
 - Ensure the Batch & Python scripts are in the same directory.
-- A sample `.bat` file (`Example.bat`) is included in the [misc](https://github.com/Nashville-Public-Library/misc/tree/main/talklib_examples) repo. 
+- A sample `.bat` file (`Example.bat`) is included in the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc/tree/main/talklib_examples) repo (This is a private repo! Contact Shared Systems team to get access).
     - Download this file and place it in the same folder as your Python file.
     - Right-Click the file > select `Properties` > select `Unblock` so that it can be executed.
     - It is a best practice to give the `.bat` and `.py` files the same name, though it is not necessary.
@@ -177,7 +177,7 @@ required for all RSS or permalink shows
 
 required for "local" shows
 - path to the local file as such: `D:\path\to\the\show.wav`
-- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [MISC](https://github.com/talkinglibrary/misc) repo for some examples.
+- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc) repo for some examples (This is a private repo! Contact Shared Systems team to get access).
 
 `is_permalink`
 

{talklib-3.6.4 → talklib-3.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "talklib"
-version = "3.6.4"
+version = "3.7.2"
 description = "A package to automate processing of shows/segments airing on the TL"
 readme = "README.md"
 license = "MIT-open-group"

{talklib-3.6.4 → talklib-3.7.2}/src/talklib/show.py

@@ -13,7 +13,7 @@ import requests
 
 from talklib.ev import EV
 from talklib.notify import Notify
-from talklib.utils import get_timestamp, clear_screen, raise_exception_and_wait, today_is_weekday
+from talklib.utils import get_timestamp, clear_screen, today_is_weekday
 from talklib.ffmpeg import FFMPEG
 
 
@@ -79,8 +79,9 @@ class TLShow(BaseModel):
             return file
         except ffmpeg_error as e:
             error: str = e.stderr.decode('utf-8')
-            self.__send_notifications(message=f"FFmpeg error: {error}. Exiting automation...", subject='Error')
-            raise_exception_and_wait(message=error)
+            to_send: str = f"FFmpeg error: {error}. Exiting automation..."
+            self.__send_notifications(message=to_send, subject='Error')
+            raise e (to_send)
 
 
     def __copy_then_remove(self, fileToCopy):
@@ -149,23 +150,29 @@ class TLShow(BaseModel):
         else:
             download_URL = self.__get_RSS_audio_url()
 
-        self.__prep_syslog(message=f'Attempting to download audio file.')
-        input_file = 'input.mp3'  # name the file we download
-        with open (input_file, mode='wb') as downloaded_file:
-            a = requests.get(download_URL)
-            downloaded_file.write(a.content)
-            downloaded_file.close()
-        
-        self.__prep_syslog(message=f'File downloaded successfully in {os.getcwd()}.')
-        return downloaded_file.name
+        self.__prep_syslog(message=f'Attempting to download audio file from {download_URL}')
+        try:
+            input_file = 'input.mp3'  # name the file we download
+            with open (input_file, mode='wb') as downloaded_file:
+                a = requests.get(download_URL)
+                downloaded_file.write(a.content)
+                downloaded_file.close()
+            
+            self.__prep_syslog(message=f'File downloaded successfully in {os.getcwd()}.')
+            return downloaded_file.name
+        except Exception as e:
+            to_send: str = f"Unable to download the file from: {download_URL}: {e}. Exiting automation!"
+            self.__send_notifications(to_send)
+            raise e (to_send)
 
     def check_downloaded_file(self, fileToCheck, how_many_attempts):
         '''TODO explain'''
         try:
             filesize = os.path.getsize(fileToCheck)
         except FileNotFoundError as error:
-            self.__send_notifications(message=f'It looks like the file does not exist. Here is the error: {error}', subject='Error')
-            raise FileNotFoundError
+            to_send: str = f"It looks like the file does not exist. Here is the error: {error}"
+            self.__send_notifications(message=to_send, subject='Error')
+            raise FileNotFoundError (to_send)
             
         is_not_empty = False
         while how_many_attempts < 3:
@@ -191,6 +198,7 @@ It looks like the downloaded file is empty. Please check manually! Yesterday's f
     def __prep_syslog(self, message: str, level: str = 'info'):
         '''send message to syslog server'''
         message = f'{self.show}: {message}'
+        print(message)
         self.notifications.send_syslog(message=message, level=level)
 
 
@@ -228,8 +236,8 @@ It looks like the file either wasn't converted or didn't transfer correctly. \
 Please check manually!\n\n\
 {get_timestamp()}")
                 self.__send_notifications(message=toSend, subject='Error')
-                raise_exception_and_wait(message=toSend)
-                break
+                raise FileNotFoundError (toSend)
+            
         if success:
             self.__countdown()
 
@@ -282,7 +290,7 @@ Is this a permalink show? Did you forget to set the is_permalink attribute?\n\n\
 {get_timestamp()}"
                 )
             self.__send_notifications(subject='Error', message=to_send)
-            raise_exception_and_wait(message=a)
+            raise a (to_send)
 
     def __check_feed_updated(self) -> bool:
         '''
@@ -316,7 +324,7 @@ Is this a permalink show? Did you forget to set the is_permalink attribute?\n\n\
             to_send = f"There's a Problem with {self.show}. \
 There is no 'enclosure' tag for the item. Here's the error: {AE}\n\n{get_timestamp()}"
             self.__send_notifications(message=to_send, subject="error")
-            raise_exception_and_wait(message=to_send, error=AE)
+            raise AE (to_send)
 
     def __check_feed_loop(self) -> str:
         '''
@@ -353,108 +361,13 @@ There is no 'enclosure' tag for the item. Here's the error: {AE}\n\n{get_timesta
             number = number-1
             time.sleep(1)
 
-    def __check_str_and_bool_type(self, attrib_to_check, type_to_check: str | bool, attrib_return: str):
-        '''
-        we are checking whether an attribute is either type str or bool, depending on what is passed in.
-        
-        'attrib_return' is solely for printing the message back out to the screen/log,
-        it is not needed for the actual type check.
-        (I can't figure out how else to get the name of the attribute)
-        '''
-        if  type(attrib_to_check) != type_to_check:
-            message = f"Sorry, '{attrib_return}' attribute must be type: {type_to_check}, but you used {type(attrib_to_check)}."
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-
-    def __check_int_and_float_type(self, attrib_to_check, attrib_return: str):
-        '''
-        Attributes passed here can be either int or float.
-        '''
-        if not (type(attrib_to_check) == int or type(attrib_to_check) == float):
-            message = f'Sorry, the {attrib_return} attribute must be a valid number (without quotes).'
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-
-    def __check_attributes_are_valid(self):
-        '''
-        Run some checks on the attributes the user has set. I.E. the required
-        attributes have been set, they are the right type, etc.
-        '''
-        self.__prep_syslog(message='checking user defined attributes')
-
-        if not self.show:
-            message = 'Sorry, you need to specify a name for the show.'
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-        else:
-            self.__check_str_and_bool_type(attrib_to_check=self.show, type_to_check=str, attrib_return='show')
-
-        if not self.show_filename:
-            message = 'Sorry, you need to specify a filename for the show.'
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-        else:
-            self.__check_str_and_bool_type(attrib_to_check=self.show_filename, type_to_check=str, attrib_return='show_filename')
-
-        if not self.url:
-            if not self.is_local:
-                message = 'Sorry, you need to specify either a URL or a local file'
-                self.__send_notifications(message=message, subject="Error")
-                raise_exception_and_wait('Sorry, you need to specify either a URL or a local file')
-
-        if self.url and self.is_local:
-            message = 'Sorry, you cannot specify both a URL and a local audio file. You must choose only one.'
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-        
-        if self.url and self.local_file:
-            message = 'Sorry, you cannot specify both a URL and a local audio file. You must choose only one.'
-            self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
-
-        if self.url:
-            self.__check_str_and_bool_type(attrib_to_check=self.url, type_to_check=str, attrib_return='url')
-        
-        if self.is_local:
-            self.__check_str_and_bool_type(attrib_to_check=self.is_local, type_to_check=bool, attrib_return='is_local')
-
-        if self.local_file:
-            self.__check_str_and_bool_type(attrib_to_check=self.local_file, type_to_check=str, attrib_return='local_file')
-        
-        if self.ffmpeg.breakaway:
-            self.__check_int_and_float_type(attrib_to_check=self.ffmpeg.breakaway, attrib_return='breakaway')
-        
-        if self.ffmpeg.compression_level:
-            self.__check_int_and_float_type(attrib_to_check=self.ffmpeg.compression_level, attrib_return='fflevel')
-
-        if self.is_permalink:
-            self.__check_str_and_bool_type(attrib_to_check=self.is_permalink, type_to_check=bool, attrib_return='is_permalink')
-
-        if not (self.check_if_above and self.check_if_below):
-            print('\n(You did not specify check_if_below and/or check_if_above. These checks will not be run.')
-        
-        if self.check_if_above:
-            self.__check_int_and_float_type(attrib_to_check=self.check_if_above, attrib_return='check_if_above')
-        
-        if self.check_if_below:
-            self.__check_int_and_float_type(attrib_to_check=self.check_if_below, attrib_return='check_if_below')
-        
-        if self.notifications.syslog_enable:
-            self.__check_str_and_bool_type(attrib_to_check=self.notifications.syslog_enable, type_to_check=bool, attrib_return='notifications')
-
-        if self.notifications.twilio_enable:
-            self.__check_str_and_bool_type(attrib_to_check=self.notifications.twilio_enable, type_to_check=bool, attrib_return='twilio_enable')
-        
-        if self.notifications.email_enable:
-            self.__check_str_and_bool_type(attrib_to_check=self.notifications.email_enable, type_to_check=bool, attrib_return='twilio_enable')
-
     def check_ffmpeg_installed(self):
         ffmpeg = shutil.which("ffmpeg")
         if not ffmpeg:
             to_send: str = f"It looks like FFmpeg is either not installed on this computer ({socket.gethostname()}), \
 or it isn't added to the PATH. You cannot use the talklib package without FFmpeg."
             self.__send_notifications(message=to_send, subject="Error")
-            raise_exception_and_wait(message=to_send)
+            raise Exception (to_send)
     
     def run(self):
         '''begins to process the file'''
@@ -462,7 +375,6 @@ or it isn't added to the PATH. You cannot use the talklib package without FFmpeg
         self.__prep_syslog(message=f'Starting script')
         print(f"I'm working on {self.show}. Just a moment...\n")
 
-        # self.__check_attributes_are_valid()
         self.check_ffmpeg_installed()
 
         if self.url and self.is_permalink:
@@ -481,7 +393,7 @@ or it isn't added to the PATH. You cannot use the talklib package without FFmpeg
         else:
             message = "Sorry, something bad happened..."
             self.__send_notifications(message=message, subject="Error")
-            raise_exception_and_wait(message=message)
+            raise Exception (message)
 
     def __run_URL_permalink(self):
         # if url is declared, it's either an RSS or permalink show
@@ -512,7 +424,7 @@ It looks like today's file hasn't yet been posted. Please check and download man
 {get_timestamp()}"
                 )
             self.__send_notifications(message=toSend, subject='Error')
-            raise_exception_and_wait(message=toSend)
+            raise Exception (toSend)
     
     def __run_local(self):
         if self.local_file:
@@ -529,4 +441,4 @@ It looks like the source file doesn't exist. Please check manually! Yesterday's
 {get_timestamp()}"
                 )
             self.__send_notifications(message=to_send, subject='Error')
-            raise_exception_and_wait(message=to_send, error=FileNotFoundError)
+            raise FileNotFoundError (to_send)

{talklib-3.6.4 → talklib-3.7.2}/src/talklib/utils.py

@@ -16,13 +16,6 @@ def clear_screen() -> None:
     else:
         os.system('clear')
 
-def raise_exception_and_wait(message: str, error = Exception) -> None:
-    '''clear terminal and print message to screen.'''
-    clear_screen()
-    print(f'{message}\n')  # get user's attention!
-    input('(press enter to close this window)') # force user to acknowledge by closing window
-    raise error (message)
-
 def today_is_weekday() -> bool:
     '''crude mechanism for determining if today is a weekday.'''
     today = datetime.now().strftime('%a')

{talklib-3.6.4 → talklib-3.7.2/src/talklib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: talklib
-Version: 3.6.4
+Version: 3.7.2
 Summary: A package to automate processing of shows/segments airing on the TL
 Author-email: Ben Weddle <ben.weddle@gmail.com>
 Maintainer-email: Ben Weddle <ben.weddle@gmail.com>
@@ -119,12 +119,12 @@ To repeat, **this package will not work without FFmpeg and FFprobe**.
 
 FFmpeg and FFprobe should be two separate binaries.
 
-The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet:
+The easiest way to install FFmpeg (and FFprobe) on Windows is with WinGet (you may need to run this in a terminal with Admin privileges):
 ````bash
 winget install Gyan.FFmpeg
 ````
 
-This should install both FFmpeg & FFprobe. After WinGet completes installation, test to ensure FFmpeg is installed:
+This should install both FFmpeg & FFprobe. After WinGet completes installation, restart your terminal and then test to ensure FFmpeg is installed:
 ````bash
 ffmpeg -version
 ````
@@ -169,7 +169,7 @@ Before we begin, a general note:
 - These are some of the reasons why we do not run `.py` files directly from WR.
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will automatically run the Python script (`.py` file).
 - Ensure the Batch & Python scripts are in the same directory.
-- A sample `.bat` file (`Example.bat`) is included in the [misc](https://github.com/Nashville-Public-Library/misc/tree/main/talklib_examples) repo. 
+- A sample `.bat` file (`Example.bat`) is included in the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc/tree/main/talklib_examples) repo (This is a private repo! Contact Shared Systems team to get access).
     - Download this file and place it in the same folder as your Python file.
     - Right-Click the file > select `Properties` > select `Unblock` so that it can be executed.
     - It is a best practice to give the `.bat` and `.py` files the same name, though it is not necessary.
@@ -258,7 +258,7 @@ required for all RSS or permalink shows
 
 required for "local" shows
 - path to the local file as such: `D:\path\to\the\show.wav`
-- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [MISC](https://github.com/talkinglibrary/misc) repo for some examples.
+- you will probably not have a hardcoded path here. Usually, you will be running a short algorithm to determine the path. Please see the [talking-library-misc](https://github.com/Nashville-Public-Library/talking-library-misc) repo for some examples (This is a private repo! Contact Shared Systems team to get access).
 
 `is_permalink`