ascii-art-python 1.0.1__tar.gz → 1.2.0__tar.gz

{ascii_art_python-1.0.1/ascii_art_python.egg-info → ascii_art_python-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ascii_art_python
-Version: 1.0.1
+Version: 1.2.0
 Summary: A Python library and CLI tool for converting images and videos into ASCII art.
 Author-email: Guillem Prieur <prieurguillem38@gmail.com>
 Project-URL: Homepage, https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
@@ -19,6 +19,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
@@ -29,6 +31,7 @@ Requires-Dist: tqdm>=4.65.0
 Requires-Dist: opencv-python-headless>=4.8.0
 Requires-Dist: moviepy>=2.0.0
 Requires-Dist: numpy>=1.24.0
+Requires-Dist: click
 Requires-Dist: importlib_resources; python_version < "3.10"
 Dynamic: license-file
 
@@ -48,41 +51,32 @@ This module provides advanced tools for converting classic images and videos int
 ## 👀 Examples
 
 ```
-@@@@@@@@@@@@@@@@@@@@@@@@@@$&#{{{{{{{{{{{#&$@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@&{*********{{{{{{{{{{{{{*{#@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@#**********{{{{{{{{{{{{{{{{{{{{$@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@#***{$@@@${*{{{{{{{{{{{{{{{{{{{{{&@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***&@@@@@&*{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{$@@@${{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{****{{{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{*************{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@&#{{{{{{{{{{{{#############{{{{{{{{{{{{{{{{{@@;.:::.::=#@@@@@@
-@@@@${********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::.=@@@@
-@@@{********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::.#@@
-@$********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::::#@
-@{******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;:::::::::::::;@
-&*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{&@$:::::::::::::::{
-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{$@@=.::::::::::::::=
-{*{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{#$@@@=.::::::::::::::::
-{{{{{{{{{{{{{{{{{{{{{#$@@@@@@@@@@@@@@@@@@@@@@@@@@$=.::::::::::::::::::
-{{{{{{{{{{{{{{{{{{#@@@@&*=;;;;;;;;;;;;;;;;;;;;:..:::::::::::::::::::::
-{{{{{{{{{{{{{{{{{$@@#:........:::::::::::::::::::::::::::::::::::::::;
-#*{{{{{{{{{{{{{{$@@:........:::::::::::::::::::::::::::::::::::::::::(
-${{{{{{{{{{{{{{{@@=.......:::::::::::::::::::::::::::::::::::::::::::&
-@#*{{{{{{{{{{{{{@$:.....::::::::::::::::::::::::::::::::::::::::::::*@
-@@{{{{{{{{{{{{{{@$:...:::::::::::::::::::::::::::::::::::::::::::::(@@
-@@@#*{{{{{{{{{{{@$:..:::::::::::::::::::::::::::::::::::::::::::::&@@@
-@@@@@#{{{{{{{{{{@$:.:::::::::::::::.:::::::::::::::::::::::::::($@@@@@
-@@@@@@@@@$$$$$$@@$:.:::::::::::::.=@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:.:::::::::::::::================*@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::::::::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::({(:::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::(@@@@@(:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@;.:::::::::::::::::::::*@@@@@*:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@$::::::::::::::::::::::::*#*:::::#@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@#:.::::::::::::::::::::::::::(@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@$*;::::::::::::::::::;(#@@@@@@@@@@@@@@@@@@@@@@@
+                 ||||||*{{*||||||                 
+             ///{{{****{{{{{{{{{{{\\              
+             |{{//-\*{{{{{{{{{{{{{{{\             
+            |*{*|   |{{{{{{{{{{{{{{{{|            
+            |*{{{*-*{{{{{{{{{{{{{{{{{|            
+             \{{{{{{{{{{{{{{{{{{{{{{{|            
+        -----           /*{{{{{{{{{{{| -----      
+   //{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::\\  
+ //{*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::::\ 
+-******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |:::::::::-
+-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| .::::::::::-
+-{**{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{//  /:::::::::::
+*{{{{{{{{{{{{{/-----------------    .:::::::::::::
+-{{{{{{{{{{{//  .----------------:::::::::::::::::
+-{{{{{{{{{{|  .......::::::::::::::::::::::::::::-
+-{{{{{{{{{{| |.....::::::::::::::::::::::::::::::-
+ |{{{{{{{{{| |....::::::::::::::::::::::::::::::/ 
+ \\{{{{{{{{| |..:::::::::::::::::::::::::::::::/  
+   \\-{{{{/| |::::::::::::-----------:::::---/    
+            |:::::::::::.\----------\             
+            |::::::::::::::::::::::::|            
+            |::::::::::::::::::.:::::|            
+            |::::::::::::::::|   |:::|            
+             |::::::::::::::::\-//::|             
+              \\::::::::::::::::::///             
+                 |||||:::::::||||                 
 ```
 
 ![Example with the Nyan Cat video played in a terminal.](https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExczN5eXo0cHRyMnRzZjVxOHI4NXN1cjc2ZzIyNHQ5cTkyMW8weHVhYSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/n0MEinoLqWEdHb129d/giphy.gif)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/README.md

@@ -14,41 +14,32 @@ This module provides advanced tools for converting classic images and videos int
 ## 👀 Examples
 
 ```
-@@@@@@@@@@@@@@@@@@@@@@@@@@$&#{{{{{{{{{{{#&$@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@&{*********{{{{{{{{{{{{{*{#@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@#**********{{{{{{{{{{{{{{{{{{{{$@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@#***{$@@@${*{{{{{{{{{{{{{{{{{{{{{&@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***&@@@@@&*{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{$@@@${{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{****{{{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{*************{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@&#{{{{{{{{{{{{#############{{{{{{{{{{{{{{{{{@@;.:::.::=#@@@@@@
-@@@@${********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::.=@@@@
-@@@{********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::.#@@
-@$********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::::#@
-@{******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;:::::::::::::;@
-&*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{&@$:::::::::::::::{
-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{$@@=.::::::::::::::=
-{*{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{#$@@@=.::::::::::::::::
-{{{{{{{{{{{{{{{{{{{{{#$@@@@@@@@@@@@@@@@@@@@@@@@@@$=.::::::::::::::::::
-{{{{{{{{{{{{{{{{{{#@@@@&*=;;;;;;;;;;;;;;;;;;;;:..:::::::::::::::::::::
-{{{{{{{{{{{{{{{{{$@@#:........:::::::::::::::::::::::::::::::::::::::;
-#*{{{{{{{{{{{{{{$@@:........:::::::::::::::::::::::::::::::::::::::::(
-${{{{{{{{{{{{{{{@@=.......:::::::::::::::::::::::::::::::::::::::::::&
-@#*{{{{{{{{{{{{{@$:.....::::::::::::::::::::::::::::::::::::::::::::*@
-@@{{{{{{{{{{{{{{@$:...:::::::::::::::::::::::::::::::::::::::::::::(@@
-@@@#*{{{{{{{{{{{@$:..:::::::::::::::::::::::::::::::::::::::::::::&@@@
-@@@@@#{{{{{{{{{{@$:.:::::::::::::::.:::::::::::::::::::::::::::($@@@@@
-@@@@@@@@@$$$$$$@@$:.:::::::::::::.=@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:.:::::::::::::::================*@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::::::::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::({(:::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::(@@@@@(:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@;.:::::::::::::::::::::*@@@@@*:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@$::::::::::::::::::::::::*#*:::::#@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@#:.::::::::::::::::::::::::::(@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@$*;::::::::::::::::::;(#@@@@@@@@@@@@@@@@@@@@@@@
+                 ||||||*{{*||||||                 
+             ///{{{****{{{{{{{{{{{\\              
+             |{{//-\*{{{{{{{{{{{{{{{\             
+            |*{*|   |{{{{{{{{{{{{{{{{|            
+            |*{{{*-*{{{{{{{{{{{{{{{{{|            
+             \{{{{{{{{{{{{{{{{{{{{{{{|            
+        -----           /*{{{{{{{{{{{| -----      
+   //{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::\\  
+ //{*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::::\ 
+-******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |:::::::::-
+-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| .::::::::::-
+-{**{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{//  /:::::::::::
+*{{{{{{{{{{{{{/-----------------    .:::::::::::::
+-{{{{{{{{{{{//  .----------------:::::::::::::::::
+-{{{{{{{{{{|  .......::::::::::::::::::::::::::::-
+-{{{{{{{{{{| |.....::::::::::::::::::::::::::::::-
+ |{{{{{{{{{| |....::::::::::::::::::::::::::::::/ 
+ \\{{{{{{{{| |..:::::::::::::::::::::::::::::::/  
+   \\-{{{{/| |::::::::::::-----------:::::---/    
+            |:::::::::::.\----------\             
+            |::::::::::::::::::::::::|            
+            |::::::::::::::::::.:::::|            
+            |::::::::::::::::|   |:::|            
+             |::::::::::::::::\-//::|             
+              \\::::::::::::::::::///             
+                 |||||:::::::||||                 
 ```
 
 ![Example with the Nyan Cat video played in a terminal.](https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExczN5eXo0cHRyMnRzZjVxOHI4NXN1cjc2ZzIyNHQ5cTkyMW8weHVhYSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/n0MEinoLqWEdHb129d/giphy.gif)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python/__init__.py

@@ -1,7 +1,7 @@
 """
 Module from https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
 """
-__version__ = "1.0.1"
+__version__ = "1.2.0"
 from . import new_skool
 from . import old_skool
 from . import full_mode

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python/ascii_base.py

@@ -1,23 +1,26 @@
 """
-Contains all the tools necessary to manage and convert images and videos into ASCII art of all types.
+Contains the tools necessary to manage and convert images and videos into ASCII art of all types.
 """
+from typing import Union, Any
 from abc import ABC, abstractmethod
 import sys
-if sys.version_info < (3, 10):
-    import importlib_resources as resources
-else:
-    from importlib import resources
 from enum import IntEnum
+import time
 from tqdm import tqdm
-import PIL.Image, PIL.ImageDraw, PIL.ImageFont
-# pylint: disable=no-member
+import PIL.Image
+import PIL.ImageDraw
+import PIL.ImageFont
 import cv2
 from moviepy import VideoFileClip
 import numpy
-import time
+if sys.version_info < (3, 10):
+    import importlib_resources as resources
+else:
+    from importlib import resources
+
 
 FONT = resources.files("ascii_art_python.assets.fonts").joinpath("KreativeSquareSM.ttf")
-SECOND_FONT = resources.files("ascii_art_python.assets.fonts").joinpath("GoogleSansCode-Regular.ttf")
+FONT2 = resources.files("ascii_art_python.assets.fonts").joinpath("GoogleSansCode-Regular.ttf")
 ASCII_CHARS: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", ".", " "]
 
 class ExportType(IntEnum):
@@ -37,12 +40,18 @@ class Image(ABC):
 
     @property
     def ratio(self) -> float:
+        """
+        The compression ratio between the original image and the desired image.
+        """
         return min(1.0, numpy.sqrt(
             self._max_len / (self._source_wb.width * self._source_wb.height)
         ))
 
     @property
     def size(self) -> tuple[int, int]:
+        """
+        Dimensions (length, width) of the generated image.
+        """
         return (
             int(self._source_wb.size[0] * self.ratio),
             int(self._source_wb.size[1] * self.ratio)
@@ -73,10 +82,10 @@ class Image(ABC):
     def __str__(self) -> str:
         return "\n".join(self.to_list())
 
-    def __len__(self):
+    def __len__(self) -> int:
         return min(self._max_len, self._source_wb.width * self._source_wb.height)
 
-    def export(self, filename: str = "mika_export", mode: ExportType = 0) -> None:
+    def export(self, filename: str = "mika_export", mode: Union[ExportType, int] = 0) -> None:
         """
         Exports the ASCII image to a text file or an image.
 
@@ -84,13 +93,13 @@ class Image(ABC):
         ----------
         filename : str, optional
             The export file name (without extension), default is "mika_export".
-        mode : ExportType, optional
+        mode : ExportType or int, optional
             The export format (text or image), default is 0 (IMAGE_FILE).
         
         Returns
         -------
         None
-            Do not return anything.
+            Does not return anything.
         """
         if mode:
             with open(f"{filename}.txt", "w", encoding="ascii") as f:
@@ -98,7 +107,7 @@ class Image(ABC):
         else:
             self.to_image().save(f"{filename}.png")
 
-    def to_image(self):
+    def to_image(self) -> PIL.Image.Image:
         """
         Converts the generated ASCII art into a readable PIL image object.
 
@@ -124,7 +133,7 @@ class Image(ABC):
         return output_image
 
     @classmethod
-    def from_path(cls, path: str, max_size: int = 10_000):
+    def from_path(cls, path: str, max_size: int = 10_000) -> "Image":
         """
         Creates an Image instance from an image file path.
 
@@ -143,7 +152,7 @@ class Image(ABC):
         return cls(PIL.Image.open(path), max_size)
 
     @classmethod
-    def from_string(cls, content: str, font_size: int = 15):
+    def from_string(cls, content: str, font_size: int = 15) -> "Image":
         """
         Creates an Image instance from a string.
 
@@ -159,26 +168,26 @@ class Image(ABC):
         Image
             A new instance of the Image class initialized with the text.
         """
-        content = content.split("\n")
+        content_list = content.split("\n")
         try:
-            font = PIL.ImageFont.truetype(SECOND_FONT, font_size)
+            font = PIL.ImageFont.truetype(FONT2, font_size)
         except IOError:
             print(f"Warning: {FONT} not found for export. Using default font.")
             font = PIL.ImageFont.load_default()
 
-        longest_line = max(content, key=len)
+        longest_line = max(content_list, key=len)
 
         text_width = int(font.getlength(longest_line))
 
-        size_export = (text_width, len(content) * font_size)
+        size_export = (text_width, len(content_list) * font_size)
 
         output_image = PIL.Image.new("L", size_export, color=255)
         draw = PIL.ImageDraw.Draw(output_image)
 
-        for i, s in enumerate(content):
+        for i, s in enumerate(content_list):
             draw.text((0, i * font_size), s, fill=0, font=font)
 
-        return cls(output_image, max_size = text_width * len(content) * font_size)
+        return cls(output_image, max_size = text_width * len(content_list) * font_size)
 
 class Video:
     """
@@ -192,7 +201,7 @@ class Video:
         LOW = 0
 
     @staticmethod
-    def transfer_audio(source_video_path, target_video_path, output_path):
+    def transfer_audio(source_video_path: str, target_video_path: str, output_path: str) -> None:
         """
         Transfers audio from a source video to a target (muted) video.
 
@@ -204,12 +213,17 @@ class Video:
             The path of the target video generated in ASCII art.
         output_path : str
             The save path for the final video combining image and sound.
+        
+        Returns
+        -------
+        None
+            Does not return anything.
         """
         source_video = VideoFileClip(source_video_path)
         audio = source_video.audio
         target_video = VideoFileClip(target_video_path)
 
-        final_video: VideoFileClip = target_video.with_audio(audio)
+        final_video = target_video.with_audio(audio)
 
         final_video.write_videofile(
             output_path,
@@ -224,7 +238,7 @@ class Video:
         final_video.close()
 
     @staticmethod
-    def print_from_txt(txt: str):
+    def print_from_txt(txt: str) -> None:
         """
         Reads and displays an ASCII animation in the terminal from a text string.
 
@@ -232,44 +246,80 @@ class Video:
         ----------
         txt : str
             The raw text containing the metadata and frames of the ASCII animation.
+
+        Returns
+        -------
+        None
+            Does not return anything.
         """
         lines = txt.split("\n")
         metadata = lines[0].split("@")
-        lines_lenght, time_between = int(metadata[0]), float(metadata[1])
+        lines_length, time_between = int(metadata[0]), float(metadata[1])
         next_sleep = time.time() + time_between
-        for i in range(len(lines) // lines_lenght):
+
+        for i in range(len(lines) // lines_length):
             time.sleep(max(next_sleep - time.time(), 0))
-            print("\n".join(lines[i*lines_lenght:(i+1) * lines_lenght]))
+            print("\n".join(lines[i * lines_length:(i + 1) * lines_length]))
             next_sleep += time_between
 
-    def __init__(self, path: str, cls: type[Image], frame_size: int = 12_000, fps: int = 10) -> None:
+    def __init__(self, path: str, cls: type, frame_size: int = 12_000, fps: int = 10) -> None:
         self.cls = cls
         self.path = path
         self.max_fps = fps
         self.max_frame_size = frame_size
 
-    def __iter__(self) -> iter:
-        cap = cv2.VideoCapture(self.path)
+        self._cap = None
+        self._frame_skip = 1
+        self._frame_count = 0
 
-        if not cap.isOpened():
+    def __iter__(self) -> "Video":
+        """
+        Initializes the video capture and returns the iterator (itself).
+        """
+        if self._cap is not None:
+            self._cap.release()
+
+        self._cap = cv2.VideoCapture(self.path)
+
+        if not self._cap.isOpened():
             raise ValueError(f"Error: Unable to open the video at the location '{self.path}'")
 
-        frame_skip = max(1, int(self.fps / self.max_fps))
-        frame_count = 0
+        self._frame_skip = max(1, int(self.fps / self.max_fps))
+        self._frame_count = 0
+
+        return self
+
+    def __next__(self) -> Any:
+        """
+        Retrieves and returns the next valid processed video frame.
+        """
+        if self._cap is None:
+            raise StopIteration
 
         while True:
-            succes, frame = cap.read()
+            succes, frame = self._cap.read()
 
             if not succes:
-                break
+                self._cap.release()
+                self._cap = None
+                raise StopIteration
 
-            if frame_count % frame_skip == 0:
-                yield self.cls(
+            if self._frame_count % self._frame_skip == 0:
+                result_frame = self.cls(
                     PIL.Image.fromarray(cv2.cvtColor(frame, cv2.COLOR_BGR2RGB)),
                     self.max_frame_size
                 )
-            frame_count += 1
-        cap.release()
+                self._frame_count += 1
+                return result_frame
+
+            self._frame_count += 1
+
+    def __del__(self) -> None:
+        """
+        Ensures the release of video resources when the object is destroyed.
+        """
+        if hasattr(self, "_cap") and self._cap is not None:
+            self._cap.release()
 
     def __len__(self) -> int:
         cap = cv2.VideoCapture(self.path)
@@ -278,9 +328,9 @@ class Video:
         if not cap.isOpened():
             raise ValueError(f"Error: Unable to open the video at the location '{self.path}'")
 
-        lenght = int(cap.get(cv2.CAP_PROP_FRAME_COUNT) / frame_skip)
+        length = int(cap.get(cv2.CAP_PROP_FRAME_COUNT) / frame_skip)
         cap.release()
-        return lenght
+        return length
 
     @property
     def fps(self) -> float:
@@ -314,6 +364,7 @@ class Video:
         cap = cv2.VideoCapture(self.path)
 
         succes, frame = cap.read()
+        cap.release()
 
         if not succes:
             raise ValueError("Error: Unable to read video frames to determine size.")
@@ -324,7 +375,11 @@ class Video:
         ).size
         return (size[0] * 20, size[1] * 20)
 
-    def export(self, filename: str = "mika_export", export_type: ExportType = 0, quality: ExportQuality = 0, sound: bool = False):
+    def export(
+        self,
+        filename: str = "mika_export", export_type: int = 0,
+        quality: Union[ExportQuality, int] = 0, sound: bool = False
+    ):
         """
         Exports the ASCII video animation to text or video (.mp4 / .avi) format.
 
@@ -332,7 +387,7 @@ class Video:
         ----------
         filename : str, optional
             The destination file name (without extension), default is "mika_export".
-        export_type : ExportType, optional
+        export_type : int, optional
             The output format (text or video), default is 0.
         quality : ExportQuality, optional
             The quality/compression level of the video, default is 0.
@@ -342,16 +397,16 @@ class Video:
         Returns
         -------
         None
-            Do not return anything.
+            Does not return anything.
         """
         if export_type:
             with open(filename + ".vid.txt", "w", encoding="ascii") as f:
-                f.write(str(self.size[1] // 40) + "@" + str(1/min(self.fps, self.max_fps)) + "\n")
-                for frame in tqdm(iter(self), "Exporting frames", len(self)):
+                f.write(str(self.size[1] // 40) + "@" + str(1 / min(self.fps, self.max_fps)) + "\n")
+                for frame in tqdm(self, "Exporting frames", len(self)):
                     f.write(frame.get_alternate_lines() + "\n")
         else:
             if quality:
-                fourcc = cv2.VideoWriter_fourcc(*'FFV1')
+                fourcc = cv2.VideoWriter_fourcc(*"FFV1")
                 out = cv2.VideoWriter(
                     filename + ".avi",
                     fourcc,
@@ -359,7 +414,7 @@ class Video:
                     self.size, False
                 )
             else:
-                fourcc = cv2.VideoWriter_fourcc(*'mp4v')
+                fourcc = cv2.VideoWriter_fourcc(*"mp4v")
                 out = cv2.VideoWriter(
                     filename + ".mp4",
                     fourcc,
@@ -367,28 +422,31 @@ class Video:
                     self.size, False
                 )
 
-            for frame in tqdm(iter(self), "Exporting frames", len(self)):
+            for frame in tqdm(self, "Exporting frames", len(self)):
                 tab = numpy.array(frame.to_image())
                 out.write(tab)
             out.release()
 
-            if sound and quality:
-                self.transfer_audio(self.path, filename + ".avi", filename + "_audio.avi")
-            elif sound:
-                self.transfer_audio(self.path, filename + ".mp4", filename + "_audio.mp4")
+            if sound:
+                print("▶ Adding audio...")
+                if quality:
+                    self.transfer_audio(self.path, filename + ".avi", filename + "_audio.avi")
+                else:
+                    self.transfer_audio(self.path, filename + ".mp4", filename + "_audio.mp4")
 
-    def print_in_terminal(self) -> None:
+    def print_in_terminal(self, func_print: callable = print) -> None:
         """
         Plays the ASCII video animation by displaying it directly in the terminal.
     
         Returns
         -------
         None
-            Do not return anything.
+            Does not return anything.
         """
-        time_between = 1/min(self.fps, self.max_fps)
+        time_between = 1 / min(self.fps, self.max_fps)
         next_sleep = time.time() + time_between
-        for frame in iter(self):
+
+        for frame in self:
             time.sleep(max(next_sleep - time.time(), 0))
-            print(frame.get_alternate_lines())
+            func_print(frame.get_alternate_lines())
             next_sleep += time_between

ascii_art_python-1.2.0/ascii_art_python/cli.py

@@ -0,0 +1,101 @@
+"""
+An ASCII art image in a style new-skool.
+"""
+import mimetypes
+import sys
+import click
+import ascii_art_python as aap
+
+
+@click.command()
+@click.argument("source_path", type=click.Path(exists=True))
+@click.argument("target_filename", type=click.STRING)
+@click.option("--length", "-l", default=15_000, help="The number of characters in the output")
+@click.option("--mode", "-m", default="full_mode", help="full_mode / old_skool / new_skool")
+def create_and_export(source_path, target_filename, length, mode):
+    """
+    Creates and exports an ASCII art image or video.
+    """
+    click.echo(f"▶ Converting '{source_path}'...")
+    click.echo(f"▶ Settings: length={length}, mode={mode}")
+
+    type_mime, _ = mimetypes.guess_type(source_path)
+
+    if type_mime is None:
+        click.secho("✗ Error: Unable to determine which export type to use")
+        sys.exit(1)
+    elif type_mime.startswith('image'):
+        click.echo("▶ Export type: image")
+        if mode == "full_mode":
+            image = aap.full_mode.Image.from_path(source_path, length)
+        elif mode == "old_skool":
+            image = aap.old_skool.Image.from_path(source_path, length)
+        elif mode == "new_skool":
+            image = aap.new_skool.Image.from_path(source_path, length)
+        else:
+            click.secho(f"✗ Error: Mode '{mode}' is not recognized.")
+            sys.exit(1)
+        image.export(target_filename)
+        click.echo("✓ Conversion complete!")
+    elif type_mime.startswith('video'):
+        click.echo("▶ Export type: video")
+        if mode == "full_mode":
+            video = aap.full_mode.Video(source_path, length, 10)
+        elif mode == "old_skool":
+            video = aap.old_skool.Video(source_path, length, 10)
+        elif mode == "new_skool":
+            video = aap.new_skool.Video(source_path, length, 10)
+        else:
+            click.secho(f"✗ Error: Mode '{mode}' is not recognized.")
+            sys.exit(1)
+        video.export(target_filename, sound=True)
+        click.echo("✓ Conversion complete!")
+    else:
+        click.secho("✗ Error: Unable to determine which export type to use")
+        sys.exit(1)
+
+@click.command()
+@click.argument("source_path", type=click.Path(exists=True))
+@click.option("--length", "-l", default=3_000, help="The number of characters in the output")
+@click.option("--mode", "-m", default="full_mode", help="full_mode / old_skool / new_skool")
+def create_and_echo(source_path, length, mode):
+    """
+    Creates and prints an ASCII art image or video.
+    """
+    click.echo(f"▶ Converting '{source_path}'...")
+    click.echo(f"▶ Settings: length={length}, mode={mode}")
+
+    type_mime, _ = mimetypes.guess_type(source_path)
+
+    if type_mime is None:
+        click.secho("✗ Error: Unable to determine which export type to use")
+        sys.exit(1)
+    elif type_mime.startswith('image'):
+        click.echo("▶ Echo type: image")
+        if mode == "full_mode":
+            image = aap.full_mode.Image.from_path(source_path, length)
+        elif mode == "old_skool":
+            image = aap.old_skool.Image.from_path(source_path, length)
+        elif mode == "new_skool":
+            image = aap.new_skool.Image.from_path(source_path, length)
+        else:
+            click.secho(f"✗ Error: Mode '{mode}' is not recognized.")
+            sys.exit(1)
+        click.echo(image.get_alternate_lines())
+        click.echo("✓ Conversion complete!")
+    elif type_mime.startswith('video'):
+        click.echo("▶ Echo type: video")
+        if mode == "full_mode":
+            video = aap.full_mode.Video(source_path, length, 5)
+        elif mode == "old_skool":
+            video = aap.old_skool.Video(source_path, length, 5)
+        elif mode == "new_skool":
+            video = aap.new_skool.Video(source_path, length, 5)
+        else:
+            click.secho(f"✗ Error: Mode '{mode}' is not recognized.")
+            sys.exit(1)
+        video.print_in_terminal(click.echo)
+        click.echo("✓ Conversion complete!")
+    else:
+        click.secho("✗ Error: Unable to determine which export type to use")
+        sys.exit(1)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python/full_mode.py

@@ -1,18 +1,30 @@
-from . import ascii_base
+"""
+ASCII art tools in a style that blends old-skool and new-skool elements.
+"""
+from typing import Union
 import PIL.Image
 import cv2
 import numpy as np
+from . import ascii_base
 
 DEFAULT_GRID: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", ".", " "]
 
 class Image(ascii_base.Image):
-    def __init__(self, image: PIL.Image.Image, max_size: int = 100_000, grid: list[str] = None) -> None:
+    """
+    An ASCII art image in a style that blends old-skool and new-skool elements.
+    """
+    def __init__(
+        self,
+        image: PIL.Image.Image,
+        max_size: int = 100_000,
+        grid: Union[list[str], None] = None
+    ) -> None:
         super().__init__(image, max_size)
         if grid is None:
             self.grid = DEFAULT_GRID
         else:
             self.grid = grid
-    
+
     def to_list(self) -> list[str]:
         size = self.size
         image = self._source_wb.resize(self.size)
@@ -41,5 +53,8 @@ class Image(ascii_base.Image):
         return ascii_list
 
 class Video(ascii_base.Video):
-    def __init__(self, path: str, frame_size: int = 12_000, fps: int = 10):
+    """
+    An ASCII art video in a style that blends old-skool and new-skool elements.
+    """
+    def __init__(self, path: str, frame_size: int = 12_000, fps: int = 10) -> None:
         super().__init__(path, Image, frame_size, fps)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python/new_skool.py

@@ -1,16 +1,28 @@
-from . import ascii_base
+"""
+ASCII art tools in a style new-skool.
+"""
+from typing import Union
 import PIL.Image
+from . import ascii_base
 
 DEFAULT_GRID: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", ".", " "]
 
 class Image(ascii_base.Image):
-    def __init__(self, image: PIL.Image.Image, max_size: int = 100_000, grid: list[str] = None) -> None:
+    """
+    An ASCII art image in a style new-skool.
+    """
+    def __init__(
+        self,
+        image: PIL.Image.Image,
+        max_size: int = 100_000,
+        grid: Union[list[str], None] = None
+    ) -> None:
         super().__init__(image, max_size)
         if grid is None:
             self.grid = DEFAULT_GRID
         else:
             self.grid = grid
-    
+
     def to_list(self) -> list[str]:
         size = self.size
         ascii_list = [""] * size[1]
@@ -22,5 +34,8 @@ class Image(ascii_base.Image):
         return ascii_list
 
 class Video(ascii_base.Video):
+    """
+    An ASCII art video in a style new-skool.
+    """
     def __init__(self, path: str, frame_size: int = 12_000, fps: int = 10):
         super().__init__(path, Image, frame_size, fps)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python/old_skool.py

@@ -1,9 +1,10 @@
 """
 Contains all the tools necessary to manage and convert images and videos into Old School ASCII art.
 """
-from . import ascii_base
 import cv2
 import numpy as np
+from . import ascii_base
+
 class Image(ascii_base.Image):
     """
     Class to convert and manipulate a classic image into Old School ASCII art.
@@ -34,5 +35,8 @@ class Image(ascii_base.Image):
         return ascii_list
 
 class Video(ascii_base.Video):
+    """
+    An ASCII art video in a style old-skool.
+    """
     def __init__(self, path: str, frame_size: int = 12_000, fps: int = 10):
         super().__init__(path, Image, frame_size, fps)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0/ascii_art_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ascii_art_python
-Version: 1.0.1
+Version: 1.2.0
 Summary: A Python library and CLI tool for converting images and videos into ASCII art.
 Author-email: Guillem Prieur <prieurguillem38@gmail.com>
 Project-URL: Homepage, https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
@@ -19,6 +19,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
@@ -29,6 +31,7 @@ Requires-Dist: tqdm>=4.65.0
 Requires-Dist: opencv-python-headless>=4.8.0
 Requires-Dist: moviepy>=2.0.0
 Requires-Dist: numpy>=1.24.0
+Requires-Dist: click
 Requires-Dist: importlib_resources; python_version < "3.10"
 Dynamic: license-file
 
@@ -48,41 +51,32 @@ This module provides advanced tools for converting classic images and videos int
 ## 👀 Examples
 
 ```
-@@@@@@@@@@@@@@@@@@@@@@@@@@$&#{{{{{{{{{{{#&$@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@&{*********{{{{{{{{{{{{{*{#@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@#**********{{{{{{{{{{{{{{{{{{{{$@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@#***{$@@@${*{{{{{{{{{{{{{{{{{{{{{&@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***&@@@@@&*{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{$@@@${{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{***{****{{{{{{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@{*************{{{{{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#{{{{{{{{{{{{{{{{@@@@@@@@@@@@@@@@@@
-@@@@@@@@&#{{{{{{{{{{{{#############{{{{{{{{{{{{{{{{{@@;.:::.::=#@@@@@@
-@@@@${********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::.=@@@@
-@@@{********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::.#@@
-@$********{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;.::::::::::::#@
-@{******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{@@;:::::::::::::;@
-&*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{&@$:::::::::::::::{
-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{$@@=.::::::::::::::=
-{*{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{#$@@@=.::::::::::::::::
-{{{{{{{{{{{{{{{{{{{{{#$@@@@@@@@@@@@@@@@@@@@@@@@@@$=.::::::::::::::::::
-{{{{{{{{{{{{{{{{{{#@@@@&*=;;;;;;;;;;;;;;;;;;;;:..:::::::::::::::::::::
-{{{{{{{{{{{{{{{{{$@@#:........:::::::::::::::::::::::::::::::::::::::;
-#*{{{{{{{{{{{{{{$@@:........:::::::::::::::::::::::::::::::::::::::::(
-${{{{{{{{{{{{{{{@@=.......:::::::::::::::::::::::::::::::::::::::::::&
-@#*{{{{{{{{{{{{{@$:.....::::::::::::::::::::::::::::::::::::::::::::*@
-@@{{{{{{{{{{{{{{@$:...:::::::::::::::::::::::::::::::::::::::::::::(@@
-@@@#*{{{{{{{{{{{@$:..:::::::::::::::::::::::::::::::::::::::::::::&@@@
-@@@@@#{{{{{{{{{{@$:.:::::::::::::::.:::::::::::::::::::::::::::($@@@@@
-@@@@@@@@@$$$$$$@@$:.:::::::::::::.=@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:.:::::::::::::::================*@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::::::::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::::({(:::::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@$:::::::::::::::::::::::(@@@@@(:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@;.:::::::::::::::::::::*@@@@@*:::=@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@$::::::::::::::::::::::::*#*:::::#@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@#:.::::::::::::::::::::::::::(@@@@@@@@@@@@@@@@@@@@
-@@@@@@@@@@@@@@@@@@@@@@@$*;::::::::::::::::::;(#@@@@@@@@@@@@@@@@@@@@@@@
+                 ||||||*{{*||||||                 
+             ///{{{****{{{{{{{{{{{\\              
+             |{{//-\*{{{{{{{{{{{{{{{\             
+            |*{*|   |{{{{{{{{{{{{{{{{|            
+            |*{{{*-*{{{{{{{{{{{{{{{{{|            
+             \{{{{{{{{{{{{{{{{{{{{{{{|            
+        -----           /*{{{{{{{{{{{| -----      
+   //{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::\\  
+ //{*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::::\ 
+-******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |:::::::::-
+-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| .::::::::::-
+-{**{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{//  /:::::::::::
+*{{{{{{{{{{{{{/-----------------    .:::::::::::::
+-{{{{{{{{{{{//  .----------------:::::::::::::::::
+-{{{{{{{{{{|  .......::::::::::::::::::::::::::::-
+-{{{{{{{{{{| |.....::::::::::::::::::::::::::::::-
+ |{{{{{{{{{| |....::::::::::::::::::::::::::::::/ 
+ \\{{{{{{{{| |..:::::::::::::::::::::::::::::::/  
+   \\-{{{{/| |::::::::::::-----------:::::---/    
+            |:::::::::::.\----------\             
+            |::::::::::::::::::::::::|            
+            |::::::::::::::::::.:::::|            
+            |::::::::::::::::|   |:::|            
+             |::::::::::::::::\-//::|             
+              \\::::::::::::::::::///             
+                 |||||:::::::||||                 
 ```
 
 ![Example with the Nyan Cat video played in a terminal.](https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExczN5eXo0cHRyMnRzZjVxOHI4NXN1cjc2ZzIyNHQ5cTkyMW8weHVhYSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/n0MEinoLqWEdHb129d/giphy.gif)

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python.egg-info/SOURCES.txt

@@ -4,12 +4,14 @@ README.md
 pyproject.toml
 ascii_art_python/__init__.py
 ascii_art_python/ascii_base.py
+ascii_art_python/cli.py
 ascii_art_python/full_mode.py
 ascii_art_python/new_skool.py
 ascii_art_python/old_skool.py
 ascii_art_python.egg-info/PKG-INFO
 ascii_art_python.egg-info/SOURCES.txt
 ascii_art_python.egg-info/dependency_links.txt
+ascii_art_python.egg-info/entry_points.txt
 ascii_art_python.egg-info/requires.txt
 ascii_art_python.egg-info/top_level.txt
 ascii_art_python/assets/fonts/GoogleSansCode-Regular.ttf

ascii_art_python-1.2.0/ascii_art_python.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+aap-echo = ascii_art_python.cli:create_and_echo
+aap-export = ascii_art_python.cli:create_and_export

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/ascii_art_python.egg-info/requires.txt

@@ -3,6 +3,7 @@ tqdm>=4.65.0
 opencv-python-headless>=4.8.0
 moviepy>=2.0.0
 numpy>=1.24.0
+click
 
 [:python_version < "3.10"]
 importlib_resources

{ascii_art_python-1.0.1 → ascii_art_python-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ascii_art_python"
-version = "1.0.1"
+version = "1.2.0"
 authors = [
     { name="Guillem Prieur", email="prieurguillem38@gmail.com" },
 ]
@@ -37,6 +37,8 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
@@ -47,6 +49,7 @@ dependencies = [
     "opencv-python-headless>=4.8.0",
     "moviepy>=2.0.0",
     "numpy>=1.24.0",
+    "click",
     "importlib_resources; python_version < '3.10'",
 ]
 
@@ -54,3 +57,7 @@ dependencies = [
 "Homepage" = "https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python"
 "Bug Tracker" = "https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python/-/issues"
 "Source Code" = "https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python"
+
+[project.scripts]
+aap-export = "ascii_art_python.cli:create_and_export"
+aap-echo = "ascii_art_python.cli:create_and_echo"