txtwrap 1.1.0__tar.gz → 1.2.0__tar.gz

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

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: txtwrap
-Version: 1.1.0
+Version: 1.2.0
 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
@@ -18,16 +18,18 @@ A tool for wrapping a text.🔨
 > **⚠️All documents are in the each module.⚠️**
 
 All constants and functions❕:
-- `LOREM_IPSUM_W`
-- `LOREM_IPSUM_S`
-- `LOREM_IPSUM_P`
-- `mono`
-- `word`
-- `wrap`
-- `align` (Updated!)
-- `fillstr` (New!)
-- `printwrap` (New!)
-- `shorten` (Updated!)
+- `LOREM_IPSUM_WORDS` (same as `LOREM_IPSUM_W`)
+- `LOREM_IPSUM_SENTENCES` (same as `LOREM_IPSUM_S`)
+- `LOREM_IPSUM_PARAGRAPHS` (same as `LOREM_IPSUM_P`)
+- `mono` (Fixed)
+- `word` (Fixed)
+- `wrap` (Fixed)
+- `align` (Updated)
+- `fillstr` (Updated)
+- `printwrap` (Updated)
+- `indent` (New)
+- `dedent` (New)
+- `shorten` (Fixed)
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -38,12 +40,12 @@ Examples❓:
 ## Render a wrap text in PyGame🎮
 ```py
 from typing import Literal, Optional
-from txtwrap import align, LOREM_IPSUM_P
+from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
 import pygame
 
 def render_wrap(
 
-    font: pygame.font.Font,
+    font: pygame.Font,
     text: str,
     width: int,
     antialias: bool,
@@ -52,21 +54,20 @@ 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+
     align_info = align(
-        text=text,
+        text_or_wrapped=str(text),
         width=width,
         linegap=linegap,
         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,48 +86,77 @@ 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(),
+    text=LOREM_IPSUM_PARAGRAPHS,
+    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
-from txtwrap import printwrap, LOREM_IPSUM_W
+from txtwrap import printwrap, LOREM_IPSUM_WORDS
 
-printwrap(LOREM_IPSUM_W, width=20, alignment='left')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='left')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='center')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='center')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='right')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='right')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='fill')
 ```
 
 ## Short a long text🔤
 ```py
-from txtwrap import shorten, LOREM_IPSUM_S
+from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
+short_lorem = shorten(LOREM_IPSUM_SENTENCES, width=20, placeholder='…')
 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_PARAGRAPHS
+
+# Set the text to be printed here
+text = LOREM_IPSUM_PARAGRAPHS
+
+remove_ansi_regex = compile(r'\x1b\[(K|.*?m)').sub
+
+def ralen(s: str) -> int:
+    return len(remove_ansi_regex('', s))
+
+while True:
+    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.2.0/README.md

@@ -0,0 +1,148 @@
+# TxTWrap🔡
+A tool for wrapping a text.🔨
+
+> **⚠️All documents are in the each module.⚠️**
+
+All constants and functions❕:
+- `LOREM_IPSUM_WORDS` (same as `LOREM_IPSUM_W`)
+- `LOREM_IPSUM_SENTENCES` (same as `LOREM_IPSUM_S`)
+- `LOREM_IPSUM_PARAGRAPHS` (same as `LOREM_IPSUM_P`)
+- `mono` (Fixed)
+- `word` (Fixed)
+- `wrap` (Fixed)
+- `align` (Updated)
+- `fillstr` (Updated)
+- `printwrap` (Updated)
+- `indent` (New)
+- `dedent` (New)
+- `shorten` (Fixed)
+
+Mod `python -m txtwrap` Commands❗:
+```shell
+python -m txtwrap --help
+```
+
+Examples❓:
+## Render a wrap text in PyGame🎮
+```py
+from typing import Literal, Optional
+from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
+import pygame
+
+def render_wrap(
+
+    font: pygame.Font,
+    text: str,
+    width: int,
+    antialias: bool,
+    color: pygame.Color,
+    background: Optional[pygame.Color] = None,
+    linegap: int = 0,
+    alignment: Literal['left', 'center', 'right', 'fill'] = 'left',
+    method: Literal['word', 'mono'] = 'word',
+    preserve_empty: bool = True,
+    use_min_width: bool = True
+
+) -> pygame.Surface:
+
+    align_info = align(
+        text_or_wrapped=str(text),
+        width=width,
+        linegap=linegap,
+        sizefunc=font.size,
+        method=method,
+        alignment=alignment,
+        preserve_empty=preserve_empty,
+        use_min_width=use_min_width,
+        return_details=True
+    )
+
+    surface = pygame.Surface(align_info['size'], pygame.SRCALPHA)
+
+    if background is not None:
+        surface.fill(background)
+
+    for x, y, text in align_info['aligned']:
+        surface.blit(font.render(text, antialias, color), (x, y))
+
+    return surface
+
+# Example usage:
+pygame.init()
+pygame.display.set_caption("Lorem Ipsum")
+
+running = True
+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_PARAGRAPHS,
+    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, pos)
+    pygame.display.flip()
+    clock.tick(60)
+```
+
+## Print a wrap text to terminal🔡
+```py
+from txtwrap import printwrap, LOREM_IPSUM_WORDS
+
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='left')
+print('=' * 20)
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='center')
+print('=' * 20)
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='right')
+print('=' * 20)
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='fill')
+```
+
+## Short a long text🔤
+```py
+from txtwrap import shorten, LOREM_IPSUM_SENTENCES
+
+short_lorem = shorten(LOREM_IPSUM_SENTENCES, width=20, placeholder='…')
+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_PARAGRAPHS
+
+# Set the text to be printed here
+text = LOREM_IPSUM_PARAGRAPHS
+
+remove_ansi_regex = compile(r'\x1b\[(K|.*?m)').sub
+
+def ralen(s: str) -> int:
+    return len(remove_ansi_regex('', s))
+
+while True:
+    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.2.0}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', encoding='utf-8') as readme:
 
 setup(
     name='txtwrap',
-    version='1.1.0',
+    version='1.2.0',
     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.2.0/txtwrap/__init__.py

@@ -0,0 +1,31 @@
+"""
+A simple text wrapping tool
+"""
+
+# Supports only in Python 3.8+
+
+from .txtwrap import (
+    version,
+    LOREM_IPSUM_WORDS, LOREM_IPSUM_SENTENCES, LOREM_IPSUM_PARAGRAPHS,
+    mono, word, wrap, align, fillstr, printwrap,
+    indent, dedent,
+    shorten
+)
+
+__version__ = version
+__author__ = 'azzammuhyala'
+__license__ = 'MIT'
+__all__ = [
+    'LOREM_IPSUM_WORDS',
+    'LOREM_IPSUM_SENTENCES',
+    'LOREM_IPSUM_PARAGRAPHS',
+    'mono',
+    'word',
+    'wrap',
+    'align',
+    'fillstr',
+    'printwrap',
+    'indent',
+    'dedent',
+    'shorten'
+]

txtwrap-1.2.0/txtwrap/__main__.py

@@ -0,0 +1,133 @@
+from argparse import ArgumentParser
+from os import name, get_terminal_size
+from txtwrap import version, printwrap, indent, dedent, shorten
+
+if name == 'nt':
+    pyname = 'python|py'
+elif name == 'posix':
+    pyname = 'python3'
+else:
+    pyname = 'python'
+
+parser = ArgumentParser(
+    prog='txtwrap',
+    description='Command-line tool for wrapping, aligning, or shortening text.',
+    epilog=f'for example: {pyname} -m txtwrap "Lorem ipsum odor amet, consectetuer adipiscing '
+            'elit." -w 20 -m word -a center'
+)
+
+parser.add_argument(
+    'text',
+    type=str,
+    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 character)>',
+    help='Fill character (default: " ")'
+)
+
+parser.add_argument(
+    '-w', '--width',
+    type=int,
+    default=None,
+    metavar='<int>',
+    help='Width of the text wrapping (default: current width terminal or 70)'
+)
+
+parser.add_argument(
+    '-m', '--method',
+    type=str,
+    choices={'word', 'mono', 'indent', 'dedent', 'shorten'},
+    default='word',
+    metavar='{word|mono|indent|dedent|shorten}',
+    help='Method to be applied to the text (default: "word")'
+)
+
+parser.add_argument(
+    '-a', '--alignment',
+    type=str,
+    choices={'left', 'center', 'right', 'fill'},
+    default='left',
+    metavar='{left|center|right|fill}',
+    help='Alignment of the text (default: "left")'
+)
+
+parser.add_argument(
+    '-n', '--neglect-empty',
+    action='store_false',
+    help='Neglect empty lines in the text'
+)
+
+parser.add_argument(
+    '-x', '--prefix',
+    type=str,
+    default=None,
+    metavar='<str>',
+    help='Prefix to be added (indent) or remove (dedent) to the text'
+)
+
+parser.add_argument(
+    '-s', '--start',
+    type=int,
+    default=0,
+    metavar='<int>',
+    help='start index of the text to be shorten (default: 0)'
+)
+
+parser.add_argument(
+    '-p', '--placeholder',
+    type=str,
+    default='...',
+    metavar='<str>',
+    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 == 'indent':
+    if args.prefix is None:
+        raise ValueError('The prefix (-x, --prefix) is required for the indent method')
+    print(indent(args.text, args.prefix))
+elif args.method == 'dedent':
+    print(dedent(args.text, args.prefix))
+elif args.method == 'shorten':
+    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,
+        fill=args.fill,
+        width=args.width,
+        method=args.method,
+        alignment=args.alignment,
+        preserve_empty=args.neglect_empty
+    )