talklib 3.2.1__tar.gz → 3.2.3__tar.gz

{talklib-3.2.1/src/talklib.egg-info → talklib-3.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: talklib
-Version: 3.2.1
+Version: 3.2.3
 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>
@@ -97,6 +97,7 @@ Requires-Dist: urllib3==2.2.2
 Requires-Dist: wrapt==1.16.0
 Requires-Dist: yarl==1.9.2
 Requires-Dist: zipp==3.17.0
+Dynamic: license-file
 
 # talklib
 
@@ -474,7 +475,9 @@ SD.run()
 
 ### Prerequisites
 
-Before starting to podcast a new show, you must log in to the server and create a directory. The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
+Before starting to podcast a new show, you must log in to the server, create a directory, and upload some files. The `talklib` CLI has several functions to help you with this. Run `talklib --help` in your terminal to see a list of these helper functions.
+
+The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
 
 You must also add two files to this directory: an RSS Feed and and an image.
 
@@ -523,7 +526,7 @@ nyt.run()
 
 To disable ALL notifications, add a line like this:
 
-> This will disable all notifications **including** syslog messages (shell print statements will not be disabled)
+> This will disable all notifications **including** syslog messages (terminal print statements will not be disabled)
 
 ````python
 from talklib import TLPod
@@ -536,6 +539,21 @@ nyt.notifications.notify.enable_all = False
 nyt.run()
 ````
 
+If the name of the corresponding directory on the server is different from the `filename_to_match` value, adjust for that like this:
+
+````python
+from talklib import TLPod
+
+nyt = TLPod(
+    display_name = "New York Times",
+    filename_to_match = "nyt",
+    bucket_folder = "newyorktimes"
+)
+nyt.run()
+````
+
+> This will match audio files that start with `nyt`, and will upload the files to the server directory called `newyorktimes`.
+
 -----
 ## Development<a id="development"></a>
 

{talklib-3.2.1 → talklib-3.2.3}/README.md

@@ -374,7 +374,9 @@ SD.run()
 
 ### Prerequisites
 
-Before starting to podcast a new show, you must log in to the server and create a directory. The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
+Before starting to podcast a new show, you must log in to the server, create a directory, and upload some files. The `talklib` CLI has several functions to help you with this. Run `talklib --help` in your terminal to see a list of these helper functions.
+
+The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
 
 You must also add two files to this directory: an RSS Feed and and an image.
 
@@ -423,7 +425,7 @@ nyt.run()
 
 To disable ALL notifications, add a line like this:
 
-> This will disable all notifications **including** syslog messages (shell print statements will not be disabled)
+> This will disable all notifications **including** syslog messages (terminal print statements will not be disabled)
 
 ````python
 from talklib import TLPod
@@ -436,6 +438,21 @@ nyt.notifications.notify.enable_all = False
 nyt.run()
 ````
 
+If the name of the corresponding directory on the server is different from the `filename_to_match` value, adjust for that like this:
+
+````python
+from talklib import TLPod
+
+nyt = TLPod(
+    display_name = "New York Times",
+    filename_to_match = "nyt",
+    bucket_folder = "newyorktimes"
+)
+nyt.run()
+````
+
+> This will match audio files that start with `nyt`, and will upload the files to the server directory called `newyorktimes`.
+
 -----
 ## Development<a id="development"></a>
 

{talklib-3.2.1 → talklib-3.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "talklib"
-version = "3.2.1"
+version = "3.2.3"
 description = "A package to automate processing of shows/segments airing on the TL"
 readme = "README.md"
 license = {file = "LICENSE.txt"}

{talklib-3.2.1 → talklib-3.2.3}/src/talklib/ev.py

@@ -41,21 +41,27 @@ import os
 class EV:
     def __init__(self):
         self.destinations = sort_destinations() # where should output files go? MUST BE A LIST EVEN WITH ONLY ONE
-        self.syslog_host = os.environ["syslog_server"] # ip of syslog server (PC with syslog software)
-        self.fromEmail = os.environ['fromEmail']  # from where should emails appear to come?
-        self.toEmail = sort_to_email()  # to where should emails be sent?
-        self.mail_server = os.environ["mail_server_external"]  # IP of mail server (ITS set this up for us)
-        self.twilio_sid = os.environ['twilio_sid'] # locate by logging in to Twilio website
-        self.twilio_token = os.environ['twilio_token']# locate by logging in to Twilio website
-        self.twilio_from = os.environ['twilio_from'] # locate by logging in to Twilio website
+        self.syslog_host = get_EV(ev="syslog_server") # ip of syslog server (PC with syslog software)
+        self.fromEmail = get_EV(ev="fromEmail") # from where should emails appear to come?
+        self.toEmail = sort_to_email() # to where should emails be sent?
+        self.mail_server = get_EV(ev="mail_server_external")  # IP of mail server (ITS set this up for us)
+        self.twilio_sid = get_EV(ev="twilio_sid") # locate by logging in to Twilio website
+        self.twilio_token = get_EV(ev="twilio_token") # locate by logging in to Twilio website
+        self.twilio_from = get_EV(ev="twilio_from") # locate by logging in to Twilio website
         self.twilio_to = sort_twilio_to() # to where should texts/calls be sent
-        self.icecast_user = os.environ['icecast_user'] # our icecast username
-        self.icecast_pass = os.environ['icecast_pass'] # our icecast password
-        self.pod_server_uname = os.environ['pod_server_uname']
+        self.icecast_user = get_EV(ev="icecast_user") # our icecast username
+        self.icecast_pass = get_EV(ev="icecast_pass") # our icecast password
+        self.pod_server_uname = get_EV(ev="pod_server_uname")
 
+def get_EV(ev: str):
+    try:
+        ev = os.environ[ev]
+        return ev
+    except KeyError:
+        raise RuntimeError(f"Missing required environment variable: {ev}")
 
 def sort_destinations():
-    destinations = os.environ['destinations']
+    destinations = get_EV(ev="destinations")
     destinations = destinations.split(",")
     destination_list = []
     for destination in destinations:
@@ -66,7 +72,7 @@ def sort_destinations():
     return destination_list
 
 def sort_to_email():
-    to_emails = os.environ['toEmail']
+    to_emails = get_EV(ev="toEmail")
     to_emails = to_emails.split(",")
     to_email_list = []
     for email in to_emails:
@@ -76,7 +82,7 @@ def sort_to_email():
     return to_email_list
 
 def sort_twilio_to():
-    twilio_to_numbers = os.environ['twilio_to']
+    twilio_to_numbers = get_EV(ev="twilio_to")
     twilio_to_numbers = twilio_to_numbers.split(",")
     twilio_to_list = []
     for number in twilio_to_numbers:

{talklib-3.2.1 → talklib-3.2.3}/src/talklib/pod.py

@@ -43,7 +43,7 @@ class Notifications(BaseModel):
             self.prep_send_mail(message=message, subject=subject)
             self.prep_syslog(message=message, level=syslog_level)
         else:
-            self.send_sms_if_enabled(message=message)
+            self.send_sms_if_enabled(message=self.prefix + ": " + message)
             self.prep_send_mail(message=message, subject=subject)
             self.prep_syslog(message=message, level=syslog_level)
 
@@ -52,6 +52,7 @@ class SSH(BaseModel):
     user: str = EV().pod_server_uname
     connection: Type[Connection] = Connection(host=server, user=user)
     notifications: Notifications = Notifications()
+    folder_exists: ClassVar[str] = False
 
     def upload_file(self, file: str, folder: str) -> None:
         self.check_folder_exists(folder=folder)
@@ -139,10 +140,13 @@ The error from the SSH library is: {e}"
         self.upload_file(file="feed.xml", folder=folder)
 
     def check_folder_exists(self, folder: str) -> bool:
+        if SSH.folder_exists:
+            return True
         self.notifications.prep_syslog(message=f"checking if {folder}/ exists on server...")
         folders = self.get_folders()
         if folder.lower() in folders:
             self.notifications.prep_syslog(message=f"{folder}/ exists on server!")
+            SSH.folder_exists = True
             return True
         
         to_send = f"cannot find folder titled: {folder}/ on server"
@@ -175,6 +179,12 @@ class Episode(BaseModel):
         self.notifications.prep_syslog(message=f"pubDate will be: {pub_date}")
         return pub_date
     
+    def copyright(self) -> str:
+        year: int = datetime.now().year
+        copyright: str = f"© 1975-{year} Nashville Talking Library - Do not copy or redistribute"
+        self.notifications.prep_syslog(message=f"copyright will be: {copyright}")
+        return copyright
+    
     def size_in_bytes(self, filename) -> str:
         size_in_bytes = os.path.getsize(filename)
         size_in_bytes = str(size_in_bytes)
@@ -298,6 +308,9 @@ class Episode(BaseModel):
         last_build_date = root.find('lastBuildDate')
         last_build_date.text = self.pub_date() # fine to use this same pub date, as the format for both is the same
 
+        copyright = root.find("copyright")
+        copyright.text = self.copyright()
+
         ET.indent(feed) # makes the XML pretty looking
         self.notifications.prep_syslog(message=f"writing feed file...")
         feed.write(self.feed_file, encoding="utf-8", xml_declaration=True)

{talklib-3.2.1 → talklib-3.2.3}/src/talklib/show.py

@@ -192,7 +192,7 @@ It looks like the downloaded file is empty. Please check manually! Yesterday's f
             self.__prep_send_mail(message=message, subject=subject)
             self.__prep_syslog(message=message, level=syslog_level)
         else:
-            self.__send_sms_if_enabled(message=message)
+            self.__send_sms_if_enabled(message=self.show + ": " + message)
             self.__prep_send_mail(message=message, subject=subject)
             self.__prep_syslog(message=message, level=syslog_level)
 

{talklib-3.2.1 → talklib-3.2.3/src/talklib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: talklib
-Version: 3.2.1
+Version: 3.2.3
 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>
@@ -97,6 +97,7 @@ Requires-Dist: urllib3==2.2.2
 Requires-Dist: wrapt==1.16.0
 Requires-Dist: yarl==1.9.2
 Requires-Dist: zipp==3.17.0
+Dynamic: license-file
 
 # talklib
 
@@ -474,7 +475,9 @@ SD.run()
 
 ### Prerequisites
 
-Before starting to podcast a new show, you must log in to the server and create a directory. The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
+Before starting to podcast a new show, you must log in to the server, create a directory, and upload some files. The `talklib` CLI has several functions to help you with this. Run `talklib --help` in your terminal to see a list of these helper functions.
+
+The directory should be named the same as the base name of the audio files for that show. For example, The Nashville Scene audio files are labelled as SceneMMDDYY. The directory name on the server should be `scene` in all lower-case.
 
 You must also add two files to this directory: an RSS Feed and and an image.
 
@@ -523,7 +526,7 @@ nyt.run()
 
 To disable ALL notifications, add a line like this:
 
-> This will disable all notifications **including** syslog messages (shell print statements will not be disabled)
+> This will disable all notifications **including** syslog messages (terminal print statements will not be disabled)
 
 ````python
 from talklib import TLPod
@@ -536,6 +539,21 @@ nyt.notifications.notify.enable_all = False
 nyt.run()
 ````
 
+If the name of the corresponding directory on the server is different from the `filename_to_match` value, adjust for that like this:
+
+````python
+from talklib import TLPod
+
+nyt = TLPod(
+    display_name = "New York Times",
+    filename_to_match = "nyt",
+    bucket_folder = "newyorktimes"
+)
+nyt.run()
+````
+
+> This will match audio files that start with `nyt`, and will upload the files to the server directory called `newyorktimes`.
+
 -----
 ## Development<a id="development"></a>