txtwrap 1.1.0__tar.gz → 1.1.1__tar.gz

{txtwrap-1.1.0/txtwrap.egg-info → txtwrap-1.1.1}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: txtwrap
-Version: 1.1.0
+Version: 1.1.1
 Summary: A simple text wrapping tool.
 Author: azzammuhyala
 License: MIT
-Keywords: wrap,wrapper,wrapping,wrapping tool,text wrap,text wrapper,simple wrap,align,aligner,aligning
+Keywords: wrap,wrapper,wrapping,wrapped,wrapping tool,text wrap,text wrapper,simple wrap,align,aligner,aligning,aligned
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -25,9 +25,9 @@ All constants and functions❕:
 - `word`
 - `wrap`
 - `align` (Updated!)
-- `fillstr` (New!)
-- `printwrap` (New!)
-- `shorten` (Updated!)
+- `fillstr`
+- `printwrap`
+- `shorten`
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -43,7 +43,7 @@ import pygame
 
 def render_wrap(
 
-    font: pygame.font.Font,
+    font: pygame.Font,
     text: str,
     width: int,
     antialias: bool,
@@ -52,12 +52,12 @@ def render_wrap(
     linegap: int = 0,
     alignment: Literal['left', 'center', 'right', 'fill'] = 'left',
     method: Literal['word', 'mono'] = 'word',
-    use_max_width: bool = True,
-    preserve_empty: bool = True
+    preserve_empty: bool = True,
+    use_min_width: bool = True
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.0+
+    # Only supports in txtwrap 1.1.1+
     align_info = align(
         text=text,
         width=width,
@@ -65,8 +65,8 @@ def render_wrap(
         sizefunc=font.size,
         method=method,
         alignment=alignment,
-        use_max_width=use_max_width,
         preserve_empty=preserve_empty,
+        use_min_width=use_min_width,
         return_details=True
     )
 
@@ -85,30 +85,35 @@ pygame.init()
 pygame.display.set_caption("Lorem Ipsum")
 
 running = True
-screen = pygame.display.set_mode((600, 510))
+wscrn, hscrn = 600, 600
+screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
     text=LOREM_IPSUM_P,
-    width=screen.get_width(),
+    width=wscrn,
     antialias=True,
     color='#ffffff',
     background='#303030',
     alignment='fill'
 )
 
+wsurf, hsurf = surface.get_size()
+pos = ((wscrn - wsurf) / 2, (hscrn - hsurf) / 2)
+
 while running:
     for event in pygame.event.get():
         if event.type == pygame.QUIT:
             running = False
     screen.fill('#000000')
-    screen.blit(surface, (0, 0))
+    screen.blit(surface, pos)
     pygame.display.flip()
     clock.tick(60)
 ```
 
 ## Print a wrap text to terminal🔡
 ```py
+# Only supports in txtwrap 1.1.0+
 from txtwrap import printwrap, LOREM_IPSUM_W
 
 printwrap(LOREM_IPSUM_W, width=20, alignment='left')
@@ -125,8 +130,35 @@ printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
 from txtwrap import shorten, LOREM_IPSUM_S
 
 short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
+# Only supports in txtwrap 1.1.0+
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
 print(test)
 ```
+
+## Bonus🎁 - Print a colorfull text to terminal🔥
+```py
+# Run this code in a terminal that supports ansi characters
+
+from re import compile
+from random import randint
+from txtwrap import printwrap, LOREM_IPSUM_P
+
+# Set the text to be printed here
+text = LOREM_IPSUM_P
+
+remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+
+def ralen(s: str) -> int:
+    return len(remove_ansi_regex('', s))
+
+while True:
+    # Only supports in txtwrap 1.1.0+
+    printwrap(
+        ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
+        end='\x1b[H\x1b[J',
+        alignment='fill',
+        lenfunc=ralen
+    )
+```

{txtwrap-1.1.0 → txtwrap-1.1.1}/README.md

@@ -11,9 +11,9 @@ All constants and functions❕:
 - `word`
 - `wrap`
 - `align` (Updated!)
-- `fillstr` (New!)
-- `printwrap` (New!)
-- `shorten` (Updated!)
+- `fillstr`
+- `printwrap`
+- `shorten`
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -29,7 +29,7 @@ import pygame
 
 def render_wrap(
 
-    font: pygame.font.Font,
+    font: pygame.Font,
     text: str,
     width: int,
     antialias: bool,
@@ -38,12 +38,12 @@ def render_wrap(
     linegap: int = 0,
     alignment: Literal['left', 'center', 'right', 'fill'] = 'left',
     method: Literal['word', 'mono'] = 'word',
-    use_max_width: bool = True,
-    preserve_empty: bool = True
+    preserve_empty: bool = True,
+    use_min_width: bool = True
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.0+
+    # Only supports in txtwrap 1.1.1+
     align_info = align(
         text=text,
         width=width,
@@ -51,8 +51,8 @@ def render_wrap(
         sizefunc=font.size,
         method=method,
         alignment=alignment,
-        use_max_width=use_max_width,
         preserve_empty=preserve_empty,
+        use_min_width=use_min_width,
         return_details=True
     )
 
@@ -71,30 +71,35 @@ pygame.init()
 pygame.display.set_caption("Lorem Ipsum")
 
 running = True
-screen = pygame.display.set_mode((600, 510))
+wscrn, hscrn = 600, 600
+screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
     text=LOREM_IPSUM_P,
-    width=screen.get_width(),
+    width=wscrn,
     antialias=True,
     color='#ffffff',
     background='#303030',
     alignment='fill'
 )
 
+wsurf, hsurf = surface.get_size()
+pos = ((wscrn - wsurf) / 2, (hscrn - hsurf) / 2)
+
 while running:
     for event in pygame.event.get():
         if event.type == pygame.QUIT:
             running = False
     screen.fill('#000000')
-    screen.blit(surface, (0, 0))
+    screen.blit(surface, pos)
     pygame.display.flip()
     clock.tick(60)
 ```
 
 ## Print a wrap text to terminal🔡
 ```py
+# Only supports in txtwrap 1.1.0+
 from txtwrap import printwrap, LOREM_IPSUM_W
 
 printwrap(LOREM_IPSUM_W, width=20, alignment='left')
@@ -111,8 +116,35 @@ printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
 from txtwrap import shorten, LOREM_IPSUM_S
 
 short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
+# Only supports in txtwrap 1.1.0+
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
 print(test)
+```
+
+## Bonus🎁 - Print a colorfull text to terminal🔥
+```py
+# Run this code in a terminal that supports ansi characters
+
+from re import compile
+from random import randint
+from txtwrap import printwrap, LOREM_IPSUM_P
+
+# Set the text to be printed here
+text = LOREM_IPSUM_P
+
+remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+
+def ralen(s: str) -> int:
+    return len(remove_ansi_regex('', s))
+
+while True:
+    # Only supports in txtwrap 1.1.0+
+    printwrap(
+        ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
+        end='\x1b[H\x1b[J',
+        alignment='fill',
+        lenfunc=ralen
+    )
 ```

{txtwrap-1.1.0 → txtwrap-1.1.1}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', encoding='utf-8') as readme:
 
 setup(
     name='txtwrap',
-    version='1.1.0',
+    version='1.1.1',
     description='A simple text wrapping tool.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -14,8 +14,8 @@ setup(
     python_requires='>=3.8',
     packages=find_packages(),
     include_package_data=True,
-    keywords=['wrap', 'wrapper', 'wrapping', 'wrapping tool', 'text wrap', 'text wrapper',
-              'simple wrap', 'align', 'aligner', 'aligning'],
+    keywords=['wrap', 'wrapper', 'wrapping', 'wrapped', 'wrapping tool', 'text wrap',
+              'text wrapper', 'simple wrap', 'align', 'aligner', 'aligning', 'aligned'],
     classifiers=[
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.8',

{txtwrap-1.1.0 → txtwrap-1.1.1}/txtwrap/__init__.py

@@ -5,14 +5,15 @@ A simple text wrapping tool
 # Supports only in Python 3.8+
 
 from .txtwrap import (
+    version,
     LOREM_IPSUM_W, LOREM_IPSUM_S, LOREM_IPSUM_P,
     mono, word, wrap, align, fillstr, printwrap,
     shorten
 )
 
-__version__ = '1.1.0'
+__version__ = version
+__author__ = 'azzammuhyala'
 __license__ = 'MIT'
-__author__ = 'Azzam Muhyala'
 __all__ = [
     'LOREM_IPSUM_W',
     'LOREM_IPSUM_S',

{txtwrap-1.1.0 → txtwrap-1.1.1}/txtwrap/__main__.py

@@ -1,5 +1,5 @@
 from argparse import ArgumentParser
-from txtwrap import printwrap, shorten
+from txtwrap import version, printwrap, shorten
 
 parser = ArgumentParser(
     description='Command-line tool for wrapping, aligning, or shortening text.'
@@ -11,19 +11,26 @@ parser.add_argument(
     help='Text to be wrapped, aligned, or shorted'
 )
 
+parser.add_argument(
+    '-v', '--version',
+    action='version',
+    version=version,
+    help='Show the version of the txtwrap'
+)
+
 parser.add_argument(
     '-f', '--fill',
     type=str,
     default=' ',
-    metavar='<str 1 length>',
-    help='Fill character (default: space)'
+    metavar='<str (1 character)>',
+    help='Fill character (default: " ")'
 )
 
 parser.add_argument(
     '-w', '--width',
     type=int,
     default=None,
-    metavar='<number>',
+    metavar='<int>',
     help='Width of the text wrapping (default: current width terminal or 70)'
 )
 
@@ -33,7 +40,7 @@ parser.add_argument(
     choices={'word', 'mono', 'shorten'},
     default='word',
     metavar='{word|mono|shorten}',
-    help='Method to be applied to the text (default: word)'
+    help='Method to be applied to the text (default: "word")'
 )
 
 parser.add_argument(
@@ -42,7 +49,7 @@ parser.add_argument(
     choices={'left', 'center', 'right', 'fill'},
     default='left',
     metavar='{left|center|right|fill}',
-    help='Alignment of the text (default: left)'
+    help='Alignment of the text (default: "left")'
 )
 
 parser.add_argument(
@@ -55,7 +62,7 @@ parser.add_argument(
     '-s', '--start',
     type=int,
     default=0,
-    metavar='<number>',
+    metavar='<int>',
     help='start index of the text to be shorten (default: 0)'
 )
 
@@ -64,13 +71,35 @@ parser.add_argument(
     type=str,
     default='...',
     metavar='<str>',
-    help='Placeholder to be used when shortening the text (default: ...)'
+    help='Placeholder to be used when shortening the text (default: "...")'
+)
+
+parser.add_argument(
+    '-r', '--no-strip',
+    action='store_false',
+    help='Do not strip the space in the text'
 )
 
 args = parser.parse_args()
 
 if args.method == 'shorten':
-    print(shorten(args.text, args.width, args.start, placeholder=args.placeholder))
+    from os import get_terminal_size
+
+    if args.width is None:
+        try:
+            args.width = get_terminal_size().columns
+        except:
+            args.width = 70
+
+    print(
+        shorten(
+            text=args.text,
+            width=args.width,
+            start=args.start,
+            placeholder=args.placeholder,
+            strip_space=args.no_strip
+        )
+    )
 else:
     printwrap(
         args.text,

{txtwrap-1.1.0 → txtwrap-1.1.1}/txtwrap/txtwrap.py

@@ -3,6 +3,7 @@ from os import get_terminal_size
 from re import compile
 
 hyphenated_regex = compile(r'(?<=-)(?=(?!-).)')
+version = '1.1.1'
 
 LOREM_IPSUM_W = 'Lorem ipsum odor amet, consectetuer adipiscing elit.'
 LOREM_IPSUM_S = ('Lorem ipsum odor amet, consectetuer adipiscing elit. In malesuada eros natoque '
@@ -198,8 +199,8 @@ def align(
     sizefunc: Callable[[str], Tuple[Union[int, float], Union[int, float]]] = lambda s : (len(s), 1),
     method: Literal['mono', 'word'] = 'word',
     alignment: Literal['left', 'center', 'right', 'fill'] = 'left',
-    use_max_width: bool = True,
     preserve_empty: bool = True,
+    use_min_width: bool = True,
     return_details: bool = False
 
 ) -> List[Union[Tuple[Union[int, float], Union[int, float], str],
@@ -226,11 +227,11 @@ def align(
                                                                           'left', 'center', 'right',
                                                                           or 'fill'.
                                                                           Defaults to 'left'.
-        use_max_width (bool, optional): Whether to use the maximum width of the wrapped text.
-                                        Defaults to True.
         preserve_empty (bool, optional): Whether to preserve empty lines. Defaults to True.
-        return_details (bool, optional): Whether to return the aligned text, wrapped text,
-                                         the maximum width, and the maximum height.
+        use_min_width (bool, optional): Whether to use the manimum width of the wrapped text.
+                                        Defaults to True.
+        return_details (bool, optional): Whether to return the aligned text, wrapped text, and
+                                         the size.
                                          Defaults to False.
 
     Returns:
@@ -238,9 +239,8 @@ def align(
              dict[Literal['aligned', 'wrapped', 'size'], Any]]: A list of tuples containing the
                                                                 position and content of each line.
                                                                 If return_details, a dictionary
-                                                                containing the wrapped text,
-                                                                the maximum width, and
-                                                                the maximum height is returned.
+                                                                containing the wrapped text, and
+                                                                the size is returned.
     """
 
     assert isinstance(linegap, (int, float)), "linegap must be an integer or float"
@@ -253,54 +253,49 @@ def align(
     aligned_positions = []
     offset_y = 0
 
-    if use_max_width:
-        max_width = max(x for x, _ in size_wrapped.values())
-
-    inforesult = {
-        'aligned': aligned_positions,
-        'wrapped': wrapped
-    }
+    if use_min_width:
+        max_width = max(size[0] for size in size_wrapped.values())
+        use_width = max_width
+    else:
+        use_width = width
 
     if alignment == 'left':
         for i, line in enumerate(wrapped):
-            _, height_line = size_wrapped[i]
+            height_line = size_wrapped[i][1]
             aligned_positions.append((0, offset_y, line))
             offset_y += height_line + linegap
 
     elif alignment == 'center':
         for i, line in enumerate(wrapped):
             width_line, height_line = size_wrapped[i]
-            aligned_positions.append(
-                (((max_width if use_max_width else width) - width_line) / 2, offset_y, line)
-            )
+            aligned_positions.append(((use_width - width_line) / 2, offset_y, line))
             offset_y += height_line + linegap
 
     elif alignment == 'right':
         for i, line in enumerate(wrapped):
             width_line, height_line = size_wrapped[i]
-            aligned_positions.append(
-                ((max_width if use_max_width else width) - width_line, offset_y, line)
-            )
+            aligned_positions.append((use_width - width_line, offset_y, line))
             offset_y += height_line + linegap
 
     elif alignment == 'fill':
+        no_spaces = True
         for i, line in enumerate(wrapped):
-            _, height_line = size_wrapped[i]
-            offset_x = 0
+            height_line = size_wrapped[i][1]
             words = line.split()
             total_words = len(words)
-            widths = {i: sizefunc(w)[0] for i, w in enumerate(words)}
-            total_words_width = sum(widths.values())
-            extra_space = width - total_words_width
+            word_widths = {i: sizefunc(w)[0] for i, w in enumerate(words)}
+            extra_space = width - sum(word_widths.values())
+            offset_x = 0
 
             if total_words > 1:
                 space_between_words = extra_space / (total_words - 1)
+                no_spaces = False
             else:
                 space_between_words = extra_space
 
             for i, w in enumerate(words):
                 aligned_positions.append((offset_x, offset_y, w))
-                offset_x += widths[i] + space_between_words
+                offset_x += word_widths[i] + space_between_words
 
             offset_y += height_line + linegap
 
@@ -308,19 +303,21 @@ def align(
         raise ValueError(f"{alignment=} is invalid, must be 'left', 'center', 'right', or 'fill'")
 
     if return_details:
-        if alignment == 'fill':
-            if text and len(wrapped) == 1 and ' ' not in wrapped[0]:
-                size_width = size_wrapped[0][0]
+        if use_min_width and alignment == 'fill':
+            if no_spaces:
+                size_width = max_width
             elif text:
                 size_width = width
             else:
                 size_width = 0
         else:
-            size_width = max_width if use_max_width else width
-
-        inforesult['size'] = (size_width, offset_y - linegap)
+            size_width = use_width
 
-        return inforesult
+        return {
+            'aligned': aligned_positions,
+            'wrapped': wrapped,
+            'size': (size_width, offset_y - linegap)
+        }
 
     return aligned_positions
 

{txtwrap-1.1.0 → txtwrap-1.1.1/txtwrap.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: txtwrap
-Version: 1.1.0
+Version: 1.1.1
 Summary: A simple text wrapping tool.
 Author: azzammuhyala
 License: MIT
-Keywords: wrap,wrapper,wrapping,wrapping tool,text wrap,text wrapper,simple wrap,align,aligner,aligning
+Keywords: wrap,wrapper,wrapping,wrapped,wrapping tool,text wrap,text wrapper,simple wrap,align,aligner,aligning,aligned
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -25,9 +25,9 @@ All constants and functions❕:
 - `word`
 - `wrap`
 - `align` (Updated!)
-- `fillstr` (New!)
-- `printwrap` (New!)
-- `shorten` (Updated!)
+- `fillstr`
+- `printwrap`
+- `shorten`
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -43,7 +43,7 @@ import pygame
 
 def render_wrap(
 
-    font: pygame.font.Font,
+    font: pygame.Font,
     text: str,
     width: int,
     antialias: bool,
@@ -52,12 +52,12 @@ def render_wrap(
     linegap: int = 0,
     alignment: Literal['left', 'center', 'right', 'fill'] = 'left',
     method: Literal['word', 'mono'] = 'word',
-    use_max_width: bool = True,
-    preserve_empty: bool = True
+    preserve_empty: bool = True,
+    use_min_width: bool = True
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.0+
+    # Only supports in txtwrap 1.1.1+
     align_info = align(
         text=text,
         width=width,
@@ -65,8 +65,8 @@ def render_wrap(
         sizefunc=font.size,
         method=method,
         alignment=alignment,
-        use_max_width=use_max_width,
         preserve_empty=preserve_empty,
+        use_min_width=use_min_width,
         return_details=True
     )
 
@@ -85,30 +85,35 @@ pygame.init()
 pygame.display.set_caption("Lorem Ipsum")
 
 running = True
-screen = pygame.display.set_mode((600, 510))
+wscrn, hscrn = 600, 600
+screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
     text=LOREM_IPSUM_P,
-    width=screen.get_width(),
+    width=wscrn,
     antialias=True,
     color='#ffffff',
     background='#303030',
     alignment='fill'
 )
 
+wsurf, hsurf = surface.get_size()
+pos = ((wscrn - wsurf) / 2, (hscrn - hsurf) / 2)
+
 while running:
     for event in pygame.event.get():
         if event.type == pygame.QUIT:
             running = False
     screen.fill('#000000')
-    screen.blit(surface, (0, 0))
+    screen.blit(surface, pos)
     pygame.display.flip()
     clock.tick(60)
 ```
 
 ## Print a wrap text to terminal🔡
 ```py
+# Only supports in txtwrap 1.1.0+
 from txtwrap import printwrap, LOREM_IPSUM_W
 
 printwrap(LOREM_IPSUM_W, width=20, alignment='left')
@@ -125,8 +130,35 @@ printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
 from txtwrap import shorten, LOREM_IPSUM_S
 
 short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
+# Only supports in txtwrap 1.1.0+
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
 print(test)
 ```
+
+## Bonus🎁 - Print a colorfull text to terminal🔥
+```py
+# Run this code in a terminal that supports ansi characters
+
+from re import compile
+from random import randint
+from txtwrap import printwrap, LOREM_IPSUM_P
+
+# Set the text to be printed here
+text = LOREM_IPSUM_P
+
+remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+
+def ralen(s: str) -> int:
+    return len(remove_ansi_regex('', s))
+
+while True:
+    # Only supports in txtwrap 1.1.0+
+    printwrap(
+        ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
+        end='\x1b[H\x1b[J',
+        alignment='fill',
+        lenfunc=ralen
+    )
+```