PyPI - talklib - Versions diffs - 1.4.0__tar.gz → 2.0.2__tar.gz - Mend

talklib 1.4.0tar.gz → 2.0.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

{talklib-1.4.0/src/talklib.egg-info → talklib-2.0.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: talklib
-Version: 1.4.0
+Version: 2.0.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>
@@ -28,25 +28,37 @@ Project-URL: Issues, https://github.com/talkinglibrary/talklib/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: aiohappyeyeballs==2.4.0
 Requires-Dist: aiohttp==3.10.5
 Requires-Dist: aiohttp-retry==2.8.3
 Requires-Dist: aiosignal==1.3.1
+Requires-Dist: annotated-types==0.7.0
 Requires-Dist: async-timeout==4.0.2
 Requires-Dist: attrs==22.1.0
+Requires-Dist: bcrypt==4.2.0
+Requires-Dist: boto3==1.35.18
+Requires-Dist: botocore==1.35.18
 Requires-Dist: build==1.0.3
 Requires-Dist: certifi==2024.8.30
+Requires-Dist: cffi==1.17.1
 Requires-Dist: charset-normalizer==2.1.1
 Requires-Dist: colorama==0.4.6
 Requires-Dist: coverage==6.5.0
+Requires-Dist: cryptography==43.0.3
+Requires-Dist: decorator==5.1.1
+Requires-Dist: Deprecated==1.2.14
 Requires-Dist: docutils==0.20.1
 Requires-Dist: exceptiongroup==1.0.4
+Requires-Dist: fabric==3.2.2
 Requires-Dist: ffmpeg-python==0.2.0
 Requires-Dist: frozenlist==1.4.1
 Requires-Dist: future==0.18.3
 Requires-Dist: idna==3.4
 Requires-Dist: importlib-metadata==7.0.1
 Requires-Dist: iniconfig==1.1.1
+Requires-Dist: invoke==2.2.0
 Requires-Dist: jaraco.classes==3.3.0
+Requires-Dist: jmespath==1.0.1
 Requires-Dist: keyring==24.3.0
 Requires-Dist: markdown-it-py==3.0.0
 Requires-Dist: mdurl==0.1.2
@@ -54,14 +66,20 @@ Requires-Dist: more-itertools==10.2.0
 Requires-Dist: multidict==6.0.4
 Requires-Dist: nh3==0.2.15
 Requires-Dist: packaging==21.3
+Requires-Dist: paramiko==3.5.0
 Requires-Dist: pkginfo==1.9.6
 Requires-Dist: pluggy==1.0.0
+Requires-Dist: pycparser==2.22
+Requires-Dist: pydantic==2.9.1
+Requires-Dist: pydantic_core==2.23.3
 Requires-Dist: Pygments==2.17.2
 Requires-Dist: PyJWT==2.6.0
+Requires-Dist: PyNaCl==1.5.0
 Requires-Dist: pyparsing==3.0.9
 Requires-Dist: pyproject_hooks==1.0.0
 Requires-Dist: pytest==7.2.0
 Requires-Dist: pytest-cov==4.0.0
+Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: pytz==2022.6
 Requires-Dist: pywin32-ctypes==0.2.2
 Requires-Dist: readme-renderer==42.0
@@ -69,10 +87,14 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: requests-toolbelt==1.0.0
 Requires-Dist: rfc3986==2.0.0
 Requires-Dist: rich==13.7.0
+Requires-Dist: s3transfer==0.10.2
+Requires-Dist: six==1.16.0
 Requires-Dist: tomli==2.0.1
 Requires-Dist: twilio==9.0.2
 Requires-Dist: twine==4.0.2
+Requires-Dist: typing_extensions==4.12.2
 Requires-Dist: urllib3==2.2.2
+Requires-Dist: wrapt==1.16.0
 Requires-Dist: yarl==1.9.2
 Requires-Dist: zipp==3.17.0
@@ -82,7 +104,7 @@ Requires-Dist: zipp==3.17.0
 [![GitHub issues](https://img.shields.io/github/issues/Nashville-Public-Library/talklib.png)](https://github.com/Nashville-Public-Library/talklib/issues)
 [![last-commit](https://img.shields.io/github/last-commit/Nashville-Public-Library/talklib)](https://github.com/Nashville-Public-Library/talklib/commits/master)
-## A package to automate processing of shows/segments airing on the TL
+## A package to automate processing TL shows/segments and podcasts
 [Skip to Examples](#examples)
@@ -102,7 +124,9 @@ Use this module to process the following types of shows/segments:
 ## Requirements
 ### -[Python](https://www.python.org/downloads/)
-Use Python 3.10 or higher
+Use Python 3.10 or higher.
+Make sure to select "add to PATH" during installation.
 ### -[FFmpeg](https://www.ffmpeg.org/download.html#build-windows)
 You need Windows binaries for both FFmpeg & FFprobe installed on the PC and added to the PATH:
@@ -121,11 +145,13 @@ See [below](#disable-twilio) for how to disable Twilio.
 ### -Environment Variables
 This package uses Environment Variables to help with portability and keep sensitive info separated. The entire list of these is in the `ev.py` file. Make sure to set **all** of these on your PC(s). They are case-sensitive!
-**ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
+> **ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
 ---
 ## Installation
+AFTER you have all of the above [requirements](#requirements), inst
 - Open a terminal/command prompt
 - ````bash
     pip install talklib
@@ -147,7 +173,10 @@ Before we begin, a general note:
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will 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.
-- PLEASE NOTE: the `.bat` file will run all Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
+    - Download this file and place it in the same folder as your Python file.
+    - Right-Click the file and click `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.
+- PLEASE NOTE: the `.bat` file will run **all** Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
 Here is what an example directory structure should look like:
 ````
@@ -156,7 +185,7 @@ D:\wireready
         -WP.bat
         -WP.py
 ````
-You would tell WR to run the `WP.bat` file, which would run the `WP.py` file.
+You would schedule WR to run the `WP.bat` file, which would run the `WP.py` file.
 ----
@@ -318,34 +347,6 @@ optional
         - be careful with this!
         - default is 21
-### Notes about formatting:
-if you're new to Python, here're some reminders
-### string
-- must be enclosed in quotes (single or double; Python doesn't care)
-### boolean
-- either True or False
-- do not enclose in quotes
-- must be capitalized
-    - correct: True
-    - incorrect: true
-### number
-- in our case, these can be either type int OR float, meaning either whole numbers OR decimal numbers are allowed
-    - OK: 5
-    - also OK: 5.4
-- do not enclose in quotes
-## Methods
-`run()`
-required
-- executes the script with the attributes you set
-- should be the last line in your script
 ## Examples<a id="examples"></a>
 ### RSS Example

{talklib-1.4.0 → talklib-2.0.2}/README.md RENAMED Viewed

@@ -4,7 +4,7 @@
 [![GitHub issues](https://img.shields.io/github/issues/Nashville-Public-Library/talklib.png)](https://github.com/Nashville-Public-Library/talklib/issues)
 [![last-commit](https://img.shields.io/github/last-commit/Nashville-Public-Library/talklib)](https://github.com/Nashville-Public-Library/talklib/commits/master)
-## A package to automate processing of shows/segments airing on the TL
+## A package to automate processing TL shows/segments and podcasts
 [Skip to Examples](#examples)
@@ -24,7 +24,9 @@ Use this module to process the following types of shows/segments:
 ## Requirements
 ### -[Python](https://www.python.org/downloads/)
-Use Python 3.10 or higher
+Use Python 3.10 or higher.
+Make sure to select "add to PATH" during installation.
 ### -[FFmpeg](https://www.ffmpeg.org/download.html#build-windows)
 You need Windows binaries for both FFmpeg & FFprobe installed on the PC and added to the PATH:
@@ -43,11 +45,13 @@ See [below](#disable-twilio) for how to disable Twilio.
 ### -Environment Variables
 This package uses Environment Variables to help with portability and keep sensitive info separated. The entire list of these is in the `ev.py` file. Make sure to set **all** of these on your PC(s). They are case-sensitive!
-**ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
+> **ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
 ---
 ## Installation
+AFTER you have all of the above [requirements](#requirements), inst
 - Open a terminal/command prompt
 - ````bash
     pip install talklib
@@ -69,7 +73,10 @@ Before we begin, a general note:
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will 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.
-- PLEASE NOTE: the `.bat` file will run all Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
+    - Download this file and place it in the same folder as your Python file.
+    - Right-Click the file and click `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.
+- PLEASE NOTE: the `.bat` file will run **all** Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
 Here is what an example directory structure should look like:
 ````
@@ -78,7 +85,7 @@ D:\wireready
         -WP.bat
         -WP.py
 ````
-You would tell WR to run the `WP.bat` file, which would run the `WP.py` file.
+You would schedule WR to run the `WP.bat` file, which would run the `WP.py` file.
 ----
@@ -240,34 +247,6 @@ optional
         - be careful with this!
         - default is 21
-### Notes about formatting:
-if you're new to Python, here're some reminders
-### string
-- must be enclosed in quotes (single or double; Python doesn't care)
-### boolean
-- either True or False
-- do not enclose in quotes
-- must be capitalized
-    - correct: True
-    - incorrect: true
-### number
-- in our case, these can be either type int OR float, meaning either whole numbers OR decimal numbers are allowed
-    - OK: 5
-    - also OK: 5.4
-- do not enclose in quotes
-## Methods
-`run()`
-required
-- executes the script with the attributes you set
-- should be the last line in your script
 ## Examples<a id="examples"></a>
 ### RSS Example

{talklib-1.4.0 → talklib-2.0.2}/pyproject.toml RENAMED Viewed

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

{talklib-1.4.0 → talklib-2.0.2}/requirements.txt RENAMED Viewed

@@ -1,22 +1,34 @@
+aiohappyeyeballs==2.4.0
 aiohttp==3.10.5
 aiohttp-retry==2.8.3
 aiosignal==1.3.1
+annotated-types==0.7.0
 async-timeout==4.0.2
 attrs==22.1.0
+bcrypt==4.2.0
+boto3==1.35.18
+botocore==1.35.18
 build==1.0.3
 certifi==2024.8.30
+cffi==1.17.1
 charset-normalizer==2.1.1
 colorama==0.4.6
 coverage==6.5.0
+cryptography==43.0.3
+decorator==5.1.1
+Deprecated==1.2.14
 docutils==0.20.1
 exceptiongroup==1.0.4
+fabric==3.2.2
 ffmpeg-python==0.2.0
 frozenlist==1.4.1
 future==0.18.3
 idna==3.4
 importlib-metadata==7.0.1
 iniconfig==1.1.1
+invoke==2.2.0
 jaraco.classes==3.3.0
+jmespath==1.0.1
 keyring==24.3.0
 markdown-it-py==3.0.0
 mdurl==0.1.2
@@ -24,14 +36,20 @@ more-itertools==10.2.0
 multidict==6.0.4
 nh3==0.2.15
 packaging==21.3
+paramiko==3.5.0
 pkginfo==1.9.6
 pluggy==1.0.0
+pycparser==2.22
+pydantic==2.9.1
+pydantic_core==2.23.3
 Pygments==2.17.2
 PyJWT==2.6.0
+PyNaCl==1.5.0
 pyparsing==3.0.9
 pyproject_hooks==1.0.0
 pytest==7.2.0
 pytest-cov==4.0.0
+python-dateutil==2.9.0.post0
 pytz==2022.6
 pywin32-ctypes==0.2.2
 readme-renderer==42.0
@@ -39,9 +57,13 @@ requests==2.32.3
 requests-toolbelt==1.0.0
 rfc3986==2.0.0
 rich==13.7.0
+s3transfer==0.10.2
+six==1.16.0
 tomli==2.0.1
 twilio==9.0.2
 twine==4.0.2
+typing_extensions==4.12.2
 urllib3==2.2.2
+wrapt==1.16.0
 yarl==1.9.2
 zipp==3.17.0

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/__init__.py RENAMED Viewed

@@ -1,3 +1,4 @@
 from talklib.show import TLShow
 from talklib.notify import Syslog
-from talklib.ffmpeg import FFMPEG
+from talklib.ffmpeg import FFMPEG
+from talklib.pod import TLPod

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/ev.py RENAMED Viewed

@@ -51,6 +51,7 @@ class EV:
         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']
 def sort_destinations():

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/ffmpeg.py RENAMED Viewed

@@ -5,6 +5,7 @@ class FFMPEG:
                 input_file: str = None,
                 output_file: str = None,
                 breakaway: int|float = 0,
+                compression: bool = True,
                 compression_level: int|float = 21,
                 sample_rate: int = 44100,
                 audio_channels: int = 1
@@ -13,6 +14,7 @@ class FFMPEG:
         self.input_file = input_file
         self.output_file = output_file
         self.breakaway = breakaway
+        self.compression = compression
         self.compression_level = compression_level
         self.sample_rate = sample_rate
         self.audio_channels = audio_channels
@@ -29,9 +31,12 @@ class FFMPEG:
         command = {}
         command.update({'ar': self.sample_rate})
         command.update({'ac': self.audio_channels})
-        command.update({'af': f'loudnorm=I=-{self.compression_level}'})
+        if self.compression:
+            command.update({'af': f'loudnorm=I=-{self.compression_level}'})
         if self.breakaway:
             command.update({'t': self.breakaway})
+        if self.output_file.endswith('mp3'):
+            command.update({'b:a': "96k"})
         command.update({'y': None})
         command.update({'filename': self.output_file})

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/notify.py RENAMED Viewed

@@ -94,7 +94,11 @@ class Notify:
             format['Subject'] = subject
             format['From'] = self.EV.fromEmail
             format['To'] = email
-            mail = smtplib.SMTP(host=self.EV.mail_server)
-            mail.send_message(format)
-            mail.quit()
+            try:
+                mail = smtplib.SMTP(host=self.EV.mail_server)
+                mail.send_message(format)
+                mail.quit()
+            except ConnectionRefusedError as e:
+                print(e)
+            except TimeoutError as e:
+                print(e)

talklib-2.0.2/src/talklib/pod.py ADDED Viewed

@@ -0,0 +1,381 @@
+from datetime import datetime
+import xml.etree.ElementTree as ET
+import glob
+import math
+import os
+import re
+import time
+from typing import ClassVar, Type
+from fabric import Connection, Result
+from pydantic import BaseModel, Field, model_validator
+from talklib.ev import EV
+from talklib.notify import Notify
+from talklib.ffmpeg import FFMPEG
+from talklib.utils import today_is_weekday
+class Notifications(BaseModel):
+    prefix: ClassVar[str] = None  # prefix all messages with identifier for the show/podcast
+    notify: Type[Notify] = Notify()
+    def prep_syslog(self, message: str, level: str = 'info'):
+        '''send message to syslog server'''
+        message = f'{self.prefix}: {message}'
+        print(message)
+        self.notify.send_syslog(message=message, level=level)
+    def prep_send_mail(self, message: str, subject: str):
+        '''send email to TL gmail account via relay address'''
+        subject = f'{subject}: {self.prefix}'
+        self.notify.send_mail(subject=subject, message=message)
+    def send_sms_if_enabled(self, message: str):
+        '''send sms via twilio IF twilio_enable is set to True'''
+        self.notify.send_sms(message=message)
+    def send_notifications(self, message: str, subject: str, syslog_level: str = 'error'):
+        '''we generally only want to send SMS via Twilio if today is on a weekend'''
+        if today_is_weekday():
+            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.prep_send_mail(message=message, subject=subject)
+            self.prep_syslog(message=message, level=syslog_level)
+class SSH(BaseModel):
+    server: str = "assets.library.nashville.org"
+    user: str = EV().pod_server_uname
+    connection: Type[Connection] = Connection(host=server, user=user)
+    notifications: Notifications = Notifications()
+    def upload_file(self, file: str, folder: str) -> None:
+        self.check_folder_exists(folder=folder)
+        try:
+            self.notifications.prep_syslog(message=f"Attempting to upload '{file}' to {folder}/")
+            self.connection.put(local=file, remote=f"talkinglibrary/shows/{folder}", preserve_mode=False)
+            self.notifications.prep_syslog(message=f"Successfully uploaded '{file}' to {folder}/")
+            return
+        except (FileNotFoundError, Exception) as e:
+            to_send = f"unable to upload '{file}': {e}"
+            self.notifications.send_notifications(message=to_send, subject='Error')
+            raise e
+    def download_file(self, file: str, folder: str) -> None:
+        try:
+            self.notifications.prep_syslog(message=f"Attempting to download '{file}' from {folder}/")
+            self.connection.get(remote=f"talkinglibrary/shows/{folder}/{file}")
+            self.notifications.prep_syslog(message=f"Successfully downloaded '{file}' to {os.getcwd()}")
+            return file
+        except Exception as e:
+            to_send = f"unable to download '{file}': {e}"
+            self.notifications.send_notifications(message=to_send, subject='Error')
+            raise e
+    def delete_file(self, file: str, folder: str) -> None:
+        try:
+            self.notifications.prep_syslog(message=f"Attempting to delete '{file}' from {folder}/")
+            self.connection.sftp().remove(f"talkinglibrary/shows/{folder}/{file}")
+            self.notifications.prep_syslog(message=f"Successfully deleted '{file}' from {folder}/")
+            return
+        except (Exception, FileNotFoundError) as e:
+            self.notifications.send_notifications(
+                message=f"Unable to delete '{file}' from {folder}: {e}. Continuing automation...",
+                subject="Error")
+    def get_folders(self) -> list:
+        ret_val: list = []
+        result: Result = self.connection.run("cd talkinglibrary/shows && ls", hide=True)
+        result_stdout:str = result.stdout
+        folders: list[str] = result_stdout.rsplit("\n")
+        for folder in folders:
+            if folder != "":
+                ret_val.append(folder.lower())
+        return ret_val
+    def get_files_from_folder(self, folder: str) -> list:
+        ret_val: list = []
+        result: Result = self.connection.run(f"cd talkinglibrary/shows/{folder} && ls", hide=True)
+        result_stdout:str = result.stdout
+        files: list[str] = result_stdout.rsplit("\n")
+        for file in files:
+            if file != "": # exclude files without names?
+                ret_val.append(file.lower())
+        return ret_val
+    def get_all_files(self) -> list:
+        ret_val: list = []
+        result: Result = self.connection.run("cd talkinglibrary/shows && ls -R", hide=True)
+        result_stdout:str = result.stdout
+        files: list[str] = result_stdout.rsplit("\n")
+        for file in files:
+            if not file.startswith("./") and file != "": # exclude folders and files without names
+                ret_val.append(file.lower())
+        return ret_val
+    def check_folder_exists(self, folder: str) -> bool:
+        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!")
+            return True
+        to_send = f"cannot find folder titled: {folder}/ on server"
+        self.notifications.send_notifications(message=to_send, subject='Error')
+        raise Exception (to_send)
+class Episode(BaseModel):
+    feed_file: str = Field(min_length=1, default=None)
+    audio_filename: str = Field(min_length=1, default=None)
+    bucket_folder: str = Field(min_length=1, default=None)
+    episode_title: str = Field(min_length=1, default=None)
+    notifications: Notifications = Notifications()
+    max_episodes: int = Field(default=None)
+    categories: list = Field(default=None)
+    def pub_date(self) -> str:
+        timezone = time.timezone/60/60 # 60 seconds per minute, 60 minutes per hour
+        timezone = round(timezone)
+        if time.localtime().tm_isdst: # if DST is currently active
+            timezone-=1
+        pub_date = datetime.now().strftime(f'%a, %d %b %Y %H:%M:%S -0{timezone}00')
+        self.notifications.prep_syslog(message=f"pubDate will be: {pub_date}")
+        return pub_date
+    def size_in_bytes(self, filename) -> str:
+        size_in_bytes = os.path.getsize(filename)
+        size_in_bytes = str(size_in_bytes)
+        self.notifications.prep_syslog(message=f"enclosure lenth will be {size_in_bytes}")
+        return size_in_bytes
+    def enclosure(self) -> str:
+        enclosure = f"https://assets.library.nashville.org/talkinglibrary/shows/{self.bucket_folder}/{self.audio_filename}"
+        self.notifications.prep_syslog(message=f"enclosure will be {enclosure}")
+        return enclosure
+    def itunes_duration(self) -> str:
+        ffmpeg = FFMPEG(input_file=self.audio_filename)
+        duration = ffmpeg.get_length_in_minutes()
+        seconds, minutes = math.modf(duration)
+        minutes = round(minutes)
+        seconds = seconds*60
+        seconds = round(seconds)
+        result = f"{minutes}:{seconds:02}"
+        self.notifications.prep_syslog(message=f"itunes:duration will be {result}")
+        return result
+    def add_new_episode(self):
+        '''Create an 'item' element. Then create all of the necessary sub elements and append them to the item element'''
+        ET.register_namespace(prefix="atom", uri="http://www.w3.org/2005/Atom")
+        ET.register_namespace(prefix="itunes", uri="http://www.itunes.com/dtds/podcast-1.0.dtd")
+        feed = ET.parse(self.feed_file)
+        root = feed.getroot()
+        root = root.find('channel')
+        item = ET.Element('item')
+        title = ET.Element('title')
+        title.text = self.episode_title
+        item.append(title)
+        pubDate = ET.Element('pubDate')
+        pubDate.text = self.pub_date()
+        item.append(pubDate)
+        enclosure = ET.Element('enclosure')
+        enclosure.set('url', self.enclosure())
+        enclosure.set('length', self.size_in_bytes(self.audio_filename))
+        enclosure.set('type', 'audio/mpeg')
+        item.append(enclosure)
+        guid = ET.Element('guid')
+        guid.set('isPermaLink', 'false')
+        guid.text = self.audio_filename # this is just the name of the audio file. useful for deleting the file later on...
+        item.append(guid)
+        itunes_duration_element = ET.Element("itunes:duration")
+        itunes_duration_element.text = self.itunes_duration()
+        item.append(itunes_duration_element)
+        for category in self.categories:
+            category_element = ET.Element("category")
+            category_element.text = category
+            self.notifications.prep_syslog(message=f"adding category: {category}")
+            item.append(category_element)
+        # insert the new 'item' element as the first item, but below all the other channel elements
+        items = root.findall('item')
+        if items:
+            # If there are existing items (there usually will be), add the new item before to the top
+            first_item = items[0]
+            index = list(root).index(first_item)
+            self.notifications.prep_syslog(message=f"adding {item} to feed at {index}")
+            root.insert(index, item)
+        else:
+            # If no items exist, add the new item to the bottom (after the other channel elements)
+            root.append(item)
+        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
+        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)
+    def remove_old_episodes(self):
+        ET.register_namespace(prefix="atom", uri="http://www.w3.org/2005/Atom")
+        ET.register_namespace(prefix="itunes", uri="http://www.itunes.com/dtds/podcast-1.0.dtd")
+        feed = ET.parse(self.feed_file)
+        root = feed.getroot()
+        root = root.find('channel')
+        items = root.findall('item')
+        number_of_items = len(items)
+        index = -1
+        while number_of_items > self.max_episodes:
+            self.notifications.prep_syslog(message=f"There are currently {number_of_items} items in the feed, which is above {self.max_episodes}")
+            item_to_remove = items[index] # locate last item in feed
+            guid = item_to_remove.find('guid').text # grab the guid (filename) so we can delete the file from the server
+            self.notifications.prep_syslog(f'removing from feed: {item_to_remove}')
+            root.remove(item_to_remove)
+            SSH().delete_file(folder=self.bucket_folder, file=guid)
+            ET.indent(feed)
+            self.notifications.prep_syslog(message=f"writing to feed file...")
+            feed.write(self.feed_file, encoding="utf-8", xml_declaration=True)
+            number_of_items-=1
+            index-=1
+class TLPod(BaseModel):
+    '''
+    everything should be in lower case!
+    display_name: generic name for the show/program. WIll be displayed as the
+    episode "Title" in the podcast feed. type=string
+    filename_to_match: the base name of the show we want to match. do not include the date.
+    for example, to match RollingStone091322, use 'RollingStone'. type=string
+    bucket_folder: the name of the folder on S3 where the audio and RSS files are stored.
+    should be lower case. type=string
+    max_episodes_in_feed: the max number of episodes that should be in the feed after you add the episode.
+    '''
+    display_name: str = Field(min_length=1)
+    filename_to_match: str = Field(min_length=1)
+    categories: list = Field(default=[])
+    bucket_folder: str = Field(default=None)
+    max_episodes_in_feed: int = Field(ge=1, default=5)
+    override_filename: bool = False
+    audio_folders:list = EV().destinations
+    notifications: Type[Notifications] = Notifications()
+    episode: Type[Episode] = Episode(notifications=notifications)
+    ffmpeg: Type[FFMPEG] = FFMPEG()
+    ssh: Type[SSH] = SSH(notifications=notifications)
+    @model_validator(mode='after')
+    def post_update(self):
+        '''
+        the name of the bucket folder should match the base name of the file. If bucket_folder is not explicitly set
+        by the user, use the filename. However, if filename_override is being used, strip out the digits first.
+        '''
+        if not self.bucket_folder:
+            if self.override_filename:
+                self.bucket_folder = re.sub(pattern="[0-9]", string=self.filename_to_match.lower(), repl='')
+            else:
+                self.bucket_folder = self.filename_to_match.lower()
+        prefix = f"{self.display_name} (podcast)"
+        Notifications.prefix = prefix
+        return self
+    def get_filename_to_match(self) -> str:
+        if self.override_filename:
+            self.notifications.prep_syslog(message="filename override is turned ON")
+            return self.filename_to_match.lower()
+        today_date: str = datetime.now().strftime("%m%d%y") # this is how we date our programs: MMDDYY
+        return (self.filename_to_match + today_date).lower()
+    def match_file(self):
+        '''match the name of the program that has today's date in the filename'''
+        to_match = self.get_filename_to_match()
+        self.notifications.prep_syslog(message=f"looking for file to match: {to_match}")
+        for dest in self.audio_folders:
+            self.notifications.prep_syslog(message=f"searching for {to_match} in {dest}...")
+            files = glob.glob(f"{dest}/*.wav")
+            for file in files:
+                if to_match in file.lower():
+                    self.notifications.prep_syslog(message="found matching file!")
+                    return file
+        to_send = f"There was a problem podcasting {self.display_name}. Cannot find matched file {to_match} in {self.audio_folders}"
+        self.notifications.send_notifications(message=to_send, subject='Error')
+        raise FileNotFoundError
+    def convert(self, file:str):
+        output_filename = file.split('.')
+        output_filename = output_filename[0]
+        output_filename = os.path.basename(output_filename).lower()
+        output_filename = output_filename + '.mp3'
+        self.notifications.prep_syslog(message=f"Converted audio file will be {output_filename}")
+        self.ffmpeg.input_file = file
+        self.ffmpeg.output_file = output_filename
+        self.ffmpeg.compression = False # this is for podcasts. these files should already be edited
+        ffmpeg_commands = self.ffmpeg.get_commands()
+        self.notifications.prep_syslog(message=f"FFmppeg commands: {ffmpeg_commands}")
+        self.notifications.prep_syslog(message=f"Converting {file} to mp3...")
+        try:
+            output = self.ffmpeg.convert()
+            self.notifications.prep_syslog(message="File successfully converted")
+            return output
+        except Exception as ffmpeg_exception:
+            self.notifications.send_notifications(message=f'FFmpeg error: {ffmpeg_exception}', subject='Error')
+            raise ffmpeg_exception
+    def delete_local_file(self, file: str):
+        try:
+            self.notifications.prep_syslog(message=f"Attempting to delete local file: {file}")
+            os.remove(file)
+            self.notifications.prep_syslog(message=f"Successfully deleted local file: {file}")
+            return
+        except Exception:
+            self.notifications.prep_syslog(message=f"Unable to delete local file: {file}")
+    def run(self):
+        self.notifications.prep_syslog(message="Starting up...")
+        self.ssh.check_folder_exists(folder=self.bucket_folder)
+        audio_file = self.match_file()
+        converted_file = self.convert(file=audio_file)
+        feed_file = self.ssh.download_file(folder=self.bucket_folder, file='feed.xml') # all XML files on server should have the same name
+        self.episode.feed_file = feed_file
+        self.episode.audio_filename = converted_file
+        self.episode.bucket_folder = self.bucket_folder
+        self.episode.categories = self.categories
+        self.episode.episode_title = f"{self.display_name} ({datetime.now().strftime('%a, %d %B')})"
+        self.episode.max_episodes = self.max_episodes_in_feed
+        self.episode.add_new_episode()
+        self.episode.remove_old_episodes()
+        self.ssh.upload_file(folder=self.bucket_folder, file=converted_file)
+        self.ssh.upload_file(folder=self.bucket_folder, file=feed_file)
+        self.delete_local_file(file=feed_file)
+        self.delete_local_file(file=converted_file)
+        self.notifications.prep_syslog(message="All done.")

{talklib-1.4.0 → talklib-2.0.2/src/talklib.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: talklib
-Version: 1.4.0
+Version: 2.0.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>
@@ -28,25 +28,37 @@ Project-URL: Issues, https://github.com/talkinglibrary/talklib/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: aiohappyeyeballs==2.4.0
 Requires-Dist: aiohttp==3.10.5
 Requires-Dist: aiohttp-retry==2.8.3
 Requires-Dist: aiosignal==1.3.1
+Requires-Dist: annotated-types==0.7.0
 Requires-Dist: async-timeout==4.0.2
 Requires-Dist: attrs==22.1.0
+Requires-Dist: bcrypt==4.2.0
+Requires-Dist: boto3==1.35.18
+Requires-Dist: botocore==1.35.18
 Requires-Dist: build==1.0.3
 Requires-Dist: certifi==2024.8.30
+Requires-Dist: cffi==1.17.1
 Requires-Dist: charset-normalizer==2.1.1
 Requires-Dist: colorama==0.4.6
 Requires-Dist: coverage==6.5.0
+Requires-Dist: cryptography==43.0.3
+Requires-Dist: decorator==5.1.1
+Requires-Dist: Deprecated==1.2.14
 Requires-Dist: docutils==0.20.1
 Requires-Dist: exceptiongroup==1.0.4
+Requires-Dist: fabric==3.2.2
 Requires-Dist: ffmpeg-python==0.2.0
 Requires-Dist: frozenlist==1.4.1
 Requires-Dist: future==0.18.3
 Requires-Dist: idna==3.4
 Requires-Dist: importlib-metadata==7.0.1
 Requires-Dist: iniconfig==1.1.1
+Requires-Dist: invoke==2.2.0
 Requires-Dist: jaraco.classes==3.3.0
+Requires-Dist: jmespath==1.0.1
 Requires-Dist: keyring==24.3.0
 Requires-Dist: markdown-it-py==3.0.0
 Requires-Dist: mdurl==0.1.2
@@ -54,14 +66,20 @@ Requires-Dist: more-itertools==10.2.0
 Requires-Dist: multidict==6.0.4
 Requires-Dist: nh3==0.2.15
 Requires-Dist: packaging==21.3
+Requires-Dist: paramiko==3.5.0
 Requires-Dist: pkginfo==1.9.6
 Requires-Dist: pluggy==1.0.0
+Requires-Dist: pycparser==2.22
+Requires-Dist: pydantic==2.9.1
+Requires-Dist: pydantic_core==2.23.3
 Requires-Dist: Pygments==2.17.2
 Requires-Dist: PyJWT==2.6.0
+Requires-Dist: PyNaCl==1.5.0
 Requires-Dist: pyparsing==3.0.9
 Requires-Dist: pyproject_hooks==1.0.0
 Requires-Dist: pytest==7.2.0
 Requires-Dist: pytest-cov==4.0.0
+Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: pytz==2022.6
 Requires-Dist: pywin32-ctypes==0.2.2
 Requires-Dist: readme-renderer==42.0
@@ -69,10 +87,14 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: requests-toolbelt==1.0.0
 Requires-Dist: rfc3986==2.0.0
 Requires-Dist: rich==13.7.0
+Requires-Dist: s3transfer==0.10.2
+Requires-Dist: six==1.16.0
 Requires-Dist: tomli==2.0.1
 Requires-Dist: twilio==9.0.2
 Requires-Dist: twine==4.0.2
+Requires-Dist: typing_extensions==4.12.2
 Requires-Dist: urllib3==2.2.2
+Requires-Dist: wrapt==1.16.0
 Requires-Dist: yarl==1.9.2
 Requires-Dist: zipp==3.17.0
@@ -82,7 +104,7 @@ Requires-Dist: zipp==3.17.0
 [![GitHub issues](https://img.shields.io/github/issues/Nashville-Public-Library/talklib.png)](https://github.com/Nashville-Public-Library/talklib/issues)
 [![last-commit](https://img.shields.io/github/last-commit/Nashville-Public-Library/talklib)](https://github.com/Nashville-Public-Library/talklib/commits/master)
-## A package to automate processing of shows/segments airing on the TL
+## A package to automate processing TL shows/segments and podcasts
 [Skip to Examples](#examples)
@@ -102,7 +124,9 @@ Use this module to process the following types of shows/segments:
 ## Requirements
 ### -[Python](https://www.python.org/downloads/)
-Use Python 3.10 or higher
+Use Python 3.10 or higher.
+Make sure to select "add to PATH" during installation.
 ### -[FFmpeg](https://www.ffmpeg.org/download.html#build-windows)
 You need Windows binaries for both FFmpeg & FFprobe installed on the PC and added to the PATH:
@@ -121,11 +145,13 @@ See [below](#disable-twilio) for how to disable Twilio.
 ### -Environment Variables
 This package uses Environment Variables to help with portability and keep sensitive info separated. The entire list of these is in the `ev.py` file. Make sure to set **all** of these on your PC(s). They are case-sensitive!
-**ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
+> **ONCE YOU SET/CHANGE/UPDATE ENVIRONMENT VARIABLES ON YOUR PC, YOU NEED TO RESTART WIREREADY**
 ---
 ## Installation
+AFTER you have all of the above [requirements](#requirements), inst
 - Open a terminal/command prompt
 - ````bash
     pip install talklib
@@ -147,7 +173,10 @@ Before we begin, a general note:
 - Instead, we tell WR to run a Batch script (`.bat` file) which in turn will 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.
-- PLEASE NOTE: the `.bat` file will run all Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
+    - Download this file and place it in the same folder as your Python file.
+    - Right-Click the file and click `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.
+- PLEASE NOTE: the `.bat` file will run **all** Python files in the folder. This is one reason it is best to separate your Python files into different folders, each with its own `.bat` file.
 Here is what an example directory structure should look like:
 ````
@@ -156,7 +185,7 @@ D:\wireready
         -WP.bat
         -WP.py
 ````
-You would tell WR to run the `WP.bat` file, which would run the `WP.py` file.
+You would schedule WR to run the `WP.bat` file, which would run the `WP.py` file.
 ----
@@ -318,34 +347,6 @@ optional
         - be careful with this!
         - default is 21
-### Notes about formatting:
-if you're new to Python, here're some reminders
-### string
-- must be enclosed in quotes (single or double; Python doesn't care)
-### boolean
-- either True or False
-- do not enclose in quotes
-- must be capitalized
-    - correct: True
-    - incorrect: true
-### number
-- in our case, these can be either type int OR float, meaning either whole numbers OR decimal numbers are allowed
-    - OK: 5
-    - also OK: 5.4
-- do not enclose in quotes
-## Methods
-`run()`
-required
-- executes the script with the attributes you set
-- should be the last line in your script
 ## Examples<a id="examples"></a>
 ### RSS Example

{talklib-1.4.0 → talklib-2.0.2}/src/talklib.egg-info/SOURCES.txt RENAMED Viewed

@@ -6,6 +6,7 @@ src/talklib/__init__.py
 src/talklib/ev.py
 src/talklib/ffmpeg.py
 src/talklib/notify.py
+src/talklib/pod.py
 src/talklib/show.py
 src/talklib/utils.py
 src/talklib.egg-info/PKG-INFO

{talklib-1.4.0 → talklib-2.0.2}/src/talklib.egg-info/requires.txt RENAMED Viewed

@@ -1,22 +1,34 @@
+aiohappyeyeballs==2.4.0
 aiohttp==3.10.5
 aiohttp-retry==2.8.3
 aiosignal==1.3.1
+annotated-types==0.7.0
 async-timeout==4.0.2
 attrs==22.1.0
+bcrypt==4.2.0
+boto3==1.35.18
+botocore==1.35.18
 build==1.0.3
 certifi==2024.8.30
+cffi==1.17.1
 charset-normalizer==2.1.1
 colorama==0.4.6
 coverage==6.5.0
+cryptography==43.0.3
+decorator==5.1.1
+Deprecated==1.2.14
 docutils==0.20.1
 exceptiongroup==1.0.4
+fabric==3.2.2
 ffmpeg-python==0.2.0
 frozenlist==1.4.1
 future==0.18.3
 idna==3.4
 importlib-metadata==7.0.1
 iniconfig==1.1.1
+invoke==2.2.0
 jaraco.classes==3.3.0
+jmespath==1.0.1
 keyring==24.3.0
 markdown-it-py==3.0.0
 mdurl==0.1.2
@@ -24,14 +36,20 @@ more-itertools==10.2.0
 multidict==6.0.4
 nh3==0.2.15
 packaging==21.3
+paramiko==3.5.0
 pkginfo==1.9.6
 pluggy==1.0.0
+pycparser==2.22
+pydantic==2.9.1
+pydantic_core==2.23.3
 Pygments==2.17.2
 PyJWT==2.6.0
+PyNaCl==1.5.0
 pyparsing==3.0.9
 pyproject_hooks==1.0.0
 pytest==7.2.0
 pytest-cov==4.0.0
+python-dateutil==2.9.0.post0
 pytz==2022.6
 pywin32-ctypes==0.2.2
 readme-renderer==42.0
@@ -39,9 +57,13 @@ requests==2.32.3
 requests-toolbelt==1.0.0
 rfc3986==2.0.0
 rich==13.7.0
+s3transfer==0.10.2
+six==1.16.0
 tomli==2.0.1
 twilio==9.0.2
 twine==4.0.2
+typing_extensions==4.12.2
 urllib3==2.2.2
+wrapt==1.16.0
 yarl==1.9.2
 zipp==3.17.0

{talklib-1.4.0 → talklib-2.0.2}/LICENSE.txt RENAMED Viewed

File without changes

{talklib-1.4.0 → talklib-2.0.2}/setup.cfg RENAMED Viewed

File without changes

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/show.py RENAMED Viewed

File without changes

{talklib-1.4.0 → talklib-2.0.2}/src/talklib/utils.py RENAMED Viewed

File without changes

{talklib-1.4.0 → talklib-2.0.2}/src/talklib.egg-info/dependency_links.txt RENAMED Viewed

File without changes

{talklib-1.4.0 → talklib-2.0.2}/src/talklib.egg-info/top_level.txt RENAMED Viewed

File without changes

talklib 1.4.0__tar.gz → 2.0.2__tar.gz

talklib 1.4.0tar.gz → 2.0.2tar.gz