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

{ascii_art_python-1.1.0/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.1.0
+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
@@ -31,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
 

{ascii_art_python-1.1.0 → 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.1.0"
+__version__ = "1.2.0"
 from . import new_skool
 from . import old_skool
 from . import full_mode

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

@@ -41,7 +41,7 @@ class Image(ABC):
     @property
     def ratio(self) -> float:
         """
-        TODO
+        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)
@@ -50,7 +50,7 @@ class Image(ABC):
     @property
     def size(self) -> tuple[int, int]:
         """
-        TODO
+        Dimensions (length, width) of the generated image.
         """
         return (
             int(self._source_wb.size[0] * self.ratio),
@@ -427,12 +427,14 @@ class Video:
                 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.
     
@@ -446,5 +448,5 @@ class Video:
 
         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.1.0 → ascii_art_python-1.2.0}/ascii_art_python/full_mode.py

@@ -1,5 +1,5 @@
 """
-TODO
+ASCII art tools in a style that blends old-skool and new-skool elements.
 """
 from typing import Union
 import PIL.Image
@@ -11,7 +11,7 @@ DEFAULT_GRID: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", "."
 
 class Image(ascii_base.Image):
     """
-    TODO
+    An ASCII art image in a style that blends old-skool and new-skool elements.
     """
     def __init__(
         self,
@@ -54,7 +54,7 @@ class Image(ascii_base.Image):
 
 class Video(ascii_base.Video):
     """
-    TODO
+    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.1.0 → ascii_art_python-1.2.0}/ascii_art_python/new_skool.py

@@ -1,5 +1,5 @@
 """
-TODO
+ASCII art tools in a style new-skool.
 """
 from typing import Union
 import PIL.Image
@@ -9,7 +9,7 @@ DEFAULT_GRID: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", "."
 
 class Image(ascii_base.Image):
     """
-    TODO
+    An ASCII art image in a style new-skool.
     """
     def __init__(
         self,
@@ -35,7 +35,7 @@ class Image(ascii_base.Image):
 
 class Video(ascii_base.Video):
     """
-    TODO
+    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.1.0 → ascii_art_python-1.2.0}/ascii_art_python/old_skool.py

@@ -36,7 +36,7 @@ class Image(ascii_base.Image):
 
 class Video(ascii_base.Video):
     """
-    TODO
+    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.1.0 → 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.1.0
+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
@@ -31,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
 

{ascii_art_python-1.1.0 → 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.1.0 → 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.1.0 → ascii_art_python-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ascii_art_python"
-version = "1.1.0"
+version = "1.2.0"
 authors = [
     { name="Guillem Prieur", email="prieurguillem38@gmail.com" },
 ]
@@ -49,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'",
 ]
 
@@ -56,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"