ascii-art-python 0.2.4__tar.gz → 0.3.0__tar.gz

{ascii_art_python-0.2.4/ascii_art_python.egg-info → ascii_art_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ascii_art_python
-Version: 0.2.4
+Version: 0.3.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
@@ -142,6 +142,8 @@ Manages the conversion and manipulation of a still image into ASCII art.
         - `grid`: The list of characters to use (from darkest to lightest). If None, uses the default grid.
 - `ImageAscii.from_path(path: str, max_size: int = 10_000, grid: list[str] = None) -> ImageAscii`
     - Description: Convenient class method to instantiate directly from a file path.
+- `ImageAscii.from_string(content: str, font_size: int) -# ImageAscii`
+    - Description: Convenient class method to instantiate directly from a character string.
 
 #### Methods
 
@@ -236,6 +238,19 @@ my_video.export(
     sound=True
 )
 ```
+
+### Example 4: Convert a text and print it in the Terminal
+
+```python
+import ascii_art_python as aap
+
+my_message = aap.new_school.ImageAscii.from_string(
+    content = "Hello, World!",
+    font_size = 15
+)
+
+print(my_message)
+```
  
 ## ⚠️ Troubleshooting
 

{ascii_art_python-0.2.4 → ascii_art_python-0.3.0}/README.md

@@ -108,6 +108,8 @@ Manages the conversion and manipulation of a still image into ASCII art.
         - `grid`: The list of characters to use (from darkest to lightest). If None, uses the default grid.
 - `ImageAscii.from_path(path: str, max_size: int = 10_000, grid: list[str] = None) -> ImageAscii`
     - Description: Convenient class method to instantiate directly from a file path.
+- `ImageAscii.from_string(content: str, font_size: int) -# ImageAscii`
+    - Description: Convenient class method to instantiate directly from a character string.
 
 #### Methods
 
@@ -202,6 +204,19 @@ my_video.export(
     sound=True
 )
 ```
+
+### Example 4: Convert a text and print it in the Terminal
+
+```python
+import ascii_art_python as aap
+
+my_message = aap.new_school.ImageAscii.from_string(
+    content = "Hello, World!",
+    font_size = 15
+)
+
+print(my_message)
+```
  
 ## ⚠️ Troubleshooting
 
@@ -213,4 +228,4 @@ Please be aware that installing both `opencv-python` (the standard version with
 
 **To avoid any issues, it is highly recommended to:**
 - **Use a Virtual Environment:** Always install this project inside an isolated virtual environment (using `venv`, `conda`, or Docker).
-- **Check Existing Packages:** If you are installing globally and already have `opencv-python` installed, please remove it first (`pip uninstall opencv-python`) before installing this project's requirements.
+- **Check Existing Packages:** If you are installing globally and already have `opencv-python` installed, please remove it first (`pip uninstall opencv-python`) before installing this project's requirements.

ascii_art_python-0.3.0/ascii_art_python/__init__.py

@@ -0,0 +1,8 @@
+"""
+Module from https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
+"""
+__version__ = "0.1.1"
+from . import new_school
+
+if __name__ == "__main__":
+    print(new_school.ImageAscii.from_string("ASCII Art", 15))

{ascii_art_python-0.2.4 → ascii_art_python-0.3.0}/ascii_art_python/new_school.py

@@ -17,6 +17,7 @@ import numpy
 import time
 
 FONT = resources.files("ascii_art_python.assets.fonts").joinpath("KreativeSquareSM.ttf")
+SECOND_FONT = resources.files("ascii_art_python.assets.fonts").joinpath("GoogleSansCode-Regular.ttf")
 ASCII_CHARS: list[str] = ["@", "$", "&", "#", "{", "*", "(", "=", ";", ":", ".", " "]
 
 class ExportType(IntEnum):
@@ -138,6 +139,44 @@ class ImageAscii:
         """
         return cls(Image.open(path), max_size, grid)
 
+    @classmethod
+    def from_string(cls, content: str, font_size: int):
+        """
+        Creates an ImageAscii instance from a string.
+
+        Parameters
+        ----------
+        content : str
+            The text you want to convert.
+        font_size : int
+            Text size.
+
+        Returns
+        -------
+        ImageAscii
+            A new instance of the ImageAscii class initialized with the text.
+        """
+        content = content.split("\n")
+        try:
+            font = ImageFont.truetype(SECOND_FONT, font_size)
+        except IOError:
+            print(f"Warning: {FONT} not found for export. Using default font.")
+            font = ImageFont.load_default()
+
+        longest_line = max(content, key=len)
+
+        text_width = int(font.getlength(longest_line))
+
+        size_export = (text_width, len(content) * font_size)
+
+        output_image = Image.new("L", size_export, color=255)
+        draw = ImageDraw.Draw(output_image)
+
+        for i, s in enumerate(content):
+            draw.text((0, i * font_size), s, fill=0, font=font)
+
+        return cls(output_image, max_size = text_width * len(content) * font_size)
+
 class VideoAscii:
     """
     Class to manage the conversion of a full video into an ASCII animation.
@@ -341,4 +380,4 @@ class VideoAscii:
             next_sleep += time_between
 
 if __name__ == "__main__":
-    print("ASCII art module loaded successfully. Run this script by importing its classes.")
+    print(ImageAscii.from_string("ASCII Art", 15))

{ascii_art_python-0.2.4 → ascii_art_python-0.3.0/ascii_art_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ascii_art_python
-Version: 0.2.4
+Version: 0.3.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
@@ -142,6 +142,8 @@ Manages the conversion and manipulation of a still image into ASCII art.
         - `grid`: The list of characters to use (from darkest to lightest). If None, uses the default grid.
 - `ImageAscii.from_path(path: str, max_size: int = 10_000, grid: list[str] = None) -> ImageAscii`
     - Description: Convenient class method to instantiate directly from a file path.
+- `ImageAscii.from_string(content: str, font_size: int) -# ImageAscii`
+    - Description: Convenient class method to instantiate directly from a character string.
 
 #### Methods
 
@@ -236,6 +238,19 @@ my_video.export(
     sound=True
 )
 ```
+
+### Example 4: Convert a text and print it in the Terminal
+
+```python
+import ascii_art_python as aap
+
+my_message = aap.new_school.ImageAscii.from_string(
+    content = "Hello, World!",
+    font_size = 15
+)
+
+print(my_message)
+```
  
 ## ⚠️ Troubleshooting
 

{ascii_art_python-0.2.4 → ascii_art_python-0.3.0}/ascii_art_python.egg-info/SOURCES.txt

@@ -9,6 +9,5 @@ ascii_art_python.egg-info/SOURCES.txt
 ascii_art_python.egg-info/dependency_links.txt
 ascii_art_python.egg-info/requires.txt
 ascii_art_python.egg-info/top_level.txt
-ascii_art_python/assets/fonts/KreativeSquare.ttf
-ascii_art_python/assets/fonts/KreativeSquareSM.ttf
-ascii_art_python/assets/fonts/OFL.txt
+ascii_art_python/assets/fonts/GoogleSansCode-Regular.ttf
+ascii_art_python/assets/fonts/KreativeSquareSM.ttf

{ascii_art_python-0.2.4 → ascii_art_python-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ascii_art_python"
-version = "0.2.4"
+version = "0.3.0"
 authors = [
     { name="Guillem Prieur", email="prieurguillem38@gmail.com" },
 ]

ascii_art_python-0.2.4/ascii_art_python/__init__.py

@@ -1,2 +0,0 @@
-__version__ = "0.1.1"
-from . import new_school

ascii_art_python-0.2.4/ascii_art_python/assets/fonts/OFL.txt

@@ -1,93 +0,0 @@
-Copyright (c) 2017-2020 Kreative Software.
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.