better-ffmpeg-progress 2.1.8__tar.gz → 2.2.0__tar.gz

{better_ffmpeg_progress-2.1.8 → better_ffmpeg_progress-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.1.8
+Version: 2.2.0
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -30,11 +30,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -78,13 +78,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    output_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -96,9 +101,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -148,3 +153,7 @@ The `run` method takes the following **optional** arguments:
 
 [19/10/2024]
 - [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
+
+[20/10/2024]
+- [v2.1.9] Do not clear the terminal before showing the progress bar.
+- [v2.2.0] Add the ability to set a custom description for the progress bar.

{better_ffmpeg_progress-2.1.8 → better_ffmpeg_progress-2.2.0}/README.md

@@ -13,11 +13,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -61,13 +61,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    output_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -79,9 +84,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -131,3 +136,7 @@ The `run` method takes the following **optional** arguments:
 
 [19/10/2024]
 - [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
+
+[20/10/2024]
+- [v2.1.9] Do not clear the terminal before showing the progress bar.
+- [v2.2.0] Add the ability to set a custom description for the progress bar.

{better_ffmpeg_progress-2.1.8 → better_ffmpeg_progress-2.2.0}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -225,6 +225,7 @@ class FfmpegProcess:
     def run(
         self,
         output_file: Optional[Union[str, Path]] = None,
+        progress_bar_description: str = None,
         progress_handler: Optional[Callable] = None,
         success_handler: Optional[Callable] = None,
         error_handler: Optional[Callable] = None,
@@ -232,6 +233,7 @@ class FfmpegProcess:
         """
         Args:
             output_file: Optional filepath to write FFmpeg output to
+            progress_bar_description: Optional string to set a custom description for the progress bar
             progress_handler: Optional function which receives progress metrics
             success_handler: Optional function to handle successful completion of the FFmpeg process
             error_handler: Optional function for FFmpeg process error handling
@@ -239,9 +241,6 @@ class FfmpegProcess:
         if not self._check_output_exists():
             return
 
-        # Clear the terminal
-        print("\033[2J\033[H", end="")
-
         print(f"Executing: {' '.join(self._ffmpeg_args)}")
 
         if self._duration_secs and not progress_handler:
@@ -255,7 +254,10 @@ class FfmpegProcess:
                 refresh_per_second=10,
             ) as progress_bar:
                 task_id = progress_bar.add_task(
-                    f"Processing {self._input_filepath.name}", total=self._duration_secs
+                    progress_bar_description
+                    if progress_bar_description is not None
+                    else f"Processing {self._input_filepath.name}",
+                    total=self._duration_secs,
                 )
 
                 self._start_process(

{better_ffmpeg_progress-2.1.8 → better_ffmpeg_progress-2.2.0}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.1.8
+Version: 2.2.0
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -30,11 +30,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -78,13 +78,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    output_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -96,9 +101,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -148,3 +153,7 @@ The `run` method takes the following **optional** arguments:
 
 [19/10/2024]
 - [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
+
+[20/10/2024]
+- [v2.1.9] Do not clear the terminal before showing the progress bar.
+- [v2.2.0] Add the ability to set a custom description for the progress bar.

{better_ffmpeg_progress-2.1.8 → better_ffmpeg_progress-2.2.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as f:
 
 setuptools.setup(
     name="better-ffmpeg-progress",
-    version="2.1.8",
+    version="2.2.0",
     author="GitHub.com/CrypticSignal",
     author_email="theaudiophile@outlook.com",
     description="Run FFmpeg & see percentage progress + ETA.",