talklib 2.0.1__tar.gz → 2.0.3__tar.gz

{talklib-2.0.1/src/talklib.egg-info → talklib-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: talklib
-Version: 2.0.1
+Version: 2.0.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>
@@ -104,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)
 
@@ -124,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:
@@ -143,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
@@ -169,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:
 ````
@@ -178,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.
 
 ----
 
@@ -340,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-2.0.1 → talklib-2.0.3}/README.md

@@ -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-2.0.1 → talklib-2.0.3}/pyproject.toml

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

{talklib-2.0.1 → talklib-2.0.3}/src/talklib/pod.py

@@ -54,9 +54,9 @@ class SSH(BaseModel):
         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}/")
+            self.notifications.prep_syslog(message=f"Attempting to upload '{file}' to {folder}/ on server")
+            self.connection.put(local=file, remote=f"shows/{folder}", preserve_mode=False)
+            self.notifications.prep_syslog(message=f"Successfully uploaded '{file}' to {folder}/ on server")
             return
         except (FileNotFoundError, Exception) as e:
             to_send = f"unable to upload '{file}': {e}"
@@ -65,8 +65,8 @@ class SSH(BaseModel):
 
     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"Attempting to download '{file}' from {folder}/ on server")
+            self.connection.get(remote=f"shows/{folder}/{file}")
             self.notifications.prep_syslog(message=f"Successfully downloaded '{file}' to {os.getcwd()}")
             return file
         except Exception as e:
@@ -76,9 +76,9 @@ class SSH(BaseModel):
 
     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}/")
+            self.notifications.prep_syslog(message=f"Attempting to delete '{file}' from {folder}/ on server")
+            self.connection.sftp().remove(f"shows/{folder}/{file}")
+            self.notifications.prep_syslog(message=f"Successfully deleted '{file}' from {folder}/ on server")
             return
         except (Exception, FileNotFoundError) as e:
             self.notifications.send_notifications(
@@ -87,7 +87,7 @@ class SSH(BaseModel):
 
     def get_folders(self) -> list:
         ret_val: list = []
-        result: Result = self.connection.run("cd talkinglibrary/shows && ls", hide=True)
+        result: Result = self.connection.run("cd shows && ls", hide=True)
         result_stdout:str = result.stdout
         folders: list[str] = result_stdout.rsplit("\n")
         for folder in folders:
@@ -97,7 +97,7 @@ class SSH(BaseModel):
     
     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: Result = self.connection.run(f"cd shows/{folder} && ls", hide=True)
         result_stdout:str = result.stdout
         files: list[str] = result_stdout.rsplit("\n")
         for file in files:
@@ -107,7 +107,7 @@ class SSH(BaseModel):
     
     def get_all_files(self) -> list:
         ret_val: list = []
-        result: Result = self.connection.run("cd talkinglibrary/shows && ls -R", hide=True)
+        result: Result = self.connection.run("cd shows && ls -R", hide=True)
         result_stdout:str = result.stdout
         files: list[str] = result_stdout.rsplit("\n")
         for file in files:
@@ -119,7 +119,7 @@ class SSH(BaseModel):
         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!")
+            self.notifications.prep_syslog(message=f"{folder}/ exists on server!")
             return True
         
         to_send = f"cannot find folder titled: {folder}/ on server"

{talklib-2.0.1 → talklib-2.0.3/src/talklib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: talklib
-Version: 2.0.1
+Version: 2.0.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>
@@ -104,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)
 
@@ -124,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:
@@ -143,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
@@ -169,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:
 ````
@@ -178,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.
 
 ----
 
@@ -340,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