txtwrap 2.3.2__tar.gz → 3.0.0__tar.gz

{txtwrap-2.3.2/txtwrap.egg-info → txtwrap-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 2.3.2
+Version: 3.0.0
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
@@ -9,11 +9,10 @@ License: MIT
 Keywords: wrap,wrapper,wrapping,wrapped,text wrap,text wrapper,text wrapping,text wrapped
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Text Processing :: Filters
-Requires-Python: >=3.3
+Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 Dynamic: author
 Dynamic: author-email
@@ -29,19 +28,21 @@ Dynamic: summary
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Version: **2.3.2** <br>
-Python requires version: **3.3.0+** <br>
-Python stub file requires version: **3.8.0+**
+Package version: **3.0.0** <br>
+Python requires version: **>=3.0.0** <br>
+Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`TextWrapper`](#textwrapper) (🔨 Fixed)
-- [`sanitize`](#sanitizetext)
-- [`wrap`](#wraptext-return_detailsfalse)
-- [`align`](#aligntext-return_detailsfalse)
-- [`fillstr`](#fillstrtext)
-- [`shorten`](#shortentext)
+- [`SEPARATOR_WHITESPACE`](#separators) (➕ New)
+- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
+- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`sanitize`](#sanitizetext) (🛠️ Fixed)
+- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
+- [`fillstr`](#fillstrtext) (🛠️ Fixed)
+- [`shorten`](#shortentext) (🛠️ Fixed)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -53,7 +54,9 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 
 <h1></h1>
 
-## Lorem ipsum
+## Constants
+
+### Lorem ipsum
 ```py
 LOREM_IPSUM_WORDS
 LOREM_IPSUM_SENTENCES
@@ -66,24 +69,39 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 
 <h1></h1>
 
+### Separators
+```py
+SEPARATOR_WHITESPACE
+SEPARATOR_ESCAPE
+```
+A collection of separators that can be used to separate text.
+- `SEPARATOR_WHITESPACE` contains whitespace characters.
+- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
+
+To use this, assign this constant to the [`separator`](#separator) parameter.
+
+<h1></h1>
+
 ## `TextWrapper`
 ```py
 class TextWrapper:
+
     def __init__(
         self,
         width: Union[int, float] = 70,
         line_padding: Union[int, float] = 0,
-        method: Literal['mono', 'word'] = 'word',
+        mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
         fillchar: str = ' ',
         separator: Optional[Union[str, Iterable[str]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty: bool = True,
+        preserve_empty_lines: bool = True,
         minimum_width: bool = True,
+        drop_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None,
+        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -116,10 +134,10 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`method`**
-(Default: `'word'`) The wrapping method. Available options:
-- `'mono'` method wraps text character by character.
-- `'word'` method wraps text word by word.
+#### **`mode`**
+(Default: `'word'`) The wrapping mode. Available options:
+- `'mono'` make text wraps character by character.
+- `'word'` make text wraps word by word.
 
 <h1></h1>
 
@@ -161,7 +179,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty`**
+#### **`preserve_empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -172,6 +190,11 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
+#### **`drop_separator`**
+(Default: `False`) Removes the separator between more than one word at a time.
+
+<h1></h1>
+
 #### **`justify_last_line`**
 (Default: `False`) Determines whether the last line should also be justified
 (applies only to `fill-...` alignments).
@@ -198,6 +221,15 @@ If the function calculates only the width, it must return a single value of type
 
 > Note: All methods can be called outside the [`TextWrapper`](#textwrapper) like external functions.
 
+For example:
+```py
+>>> txtwrap.TextWrapper(20, placeholder='[...]').shorten("Hello World!")
+```
+is equivalent to:
+```py
+>>> txtwrap.shorten("Hello World!", 20, placeholder='[...]')
+```
+
 <h1></h1>
 
 #### **`copy`**
@@ -220,44 +252,56 @@ For example:
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
-- `'indiced'`: A set of indices marking the end of line (starting from `0`, like programming indices).
+- `'start_lines'`: A set of indices marking the start of line.
+- `'end_lines'`: A set of indices marking the end of line.
 
 For example:
 ```py
 >>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
 ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'indiced': {4}}
+>>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
+>>> info
+{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
+>>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum'
+>>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+'elit.'
 ```
 
 <h1></h1>
 
 #### **`align(text, return_details=False)`**
-Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along with its
-coordinates.
+Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
+with its coordinates.
 > Note: [`sizefunc`](#sizefunc) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
-- `'wrapped'`: The result from wrap.
-- `'indiced'`: The indices of line breaks.
-- `'size'`: The calculated text size.
+- `'wrapped'`: A list of wrapped text fragments.
+- `'start_lines'`: A set of indices marking the start of line.
+- `'end_lines'`: A set of indices marking the end of line.
+- `'size'`: A calculated text size.
 
 For example:
 ```py
 >>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'indiced': {2}, 'size': (18, 3)}
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
+>>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor'
+>>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc) (size or just length) must return `int`,
-not `float`!
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+(size or just length) must return `int`, not `float`!
 
 For example:
 ```py
@@ -301,12 +345,13 @@ def render_wrap(
     color: pygame.Color,
     background: Optional[pygame.Color] = None,
     line_padding: int = 0,
-    method: Literal['word', 'mono'] = 'word',
+    wrap_mode: Literal['word', 'mono'] = 'word',
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty: bool = True,
+    preserve_empty_lines: bool = True,
     minimum_width: bool = True,
+    drop_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -316,12 +361,13 @@ def render_wrap(
         text=text,
         width=width,
         line_padding=line_padding,
-        method=method,
+        mode=wrap_mode,
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty=preserve_empty,
+        preserve_empty_lines=preserve_empty_lines,
         minimum_width=minimum_width,
+        drop_separator=drop_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,

{txtwrap-2.3.2 → txtwrap-3.0.0}/README.md

@@ -1,19 +1,21 @@
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Version: **2.3.2** <br>
-Python requires version: **3.3.0+** <br>
-Python stub file requires version: **3.8.0+**
+Package version: **3.0.0** <br>
+Python requires version: **>=3.0.0** <br>
+Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`TextWrapper`](#textwrapper) (🔨 Fixed)
-- [`sanitize`](#sanitizetext)
-- [`wrap`](#wraptext-return_detailsfalse)
-- [`align`](#aligntext-return_detailsfalse)
-- [`fillstr`](#fillstrtext)
-- [`shorten`](#shortentext)
+- [`SEPARATOR_WHITESPACE`](#separators) (➕ New)
+- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
+- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`sanitize`](#sanitizetext) (🛠️ Fixed)
+- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
+- [`fillstr`](#fillstrtext) (🛠️ Fixed)
+- [`shorten`](#shortentext) (🛠️ Fixed)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -25,7 +27,9 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 
 <h1></h1>
 
-## Lorem ipsum
+## Constants
+
+### Lorem ipsum
 ```py
 LOREM_IPSUM_WORDS
 LOREM_IPSUM_SENTENCES
@@ -38,24 +42,39 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 
 <h1></h1>
 
+### Separators
+```py
+SEPARATOR_WHITESPACE
+SEPARATOR_ESCAPE
+```
+A collection of separators that can be used to separate text.
+- `SEPARATOR_WHITESPACE` contains whitespace characters.
+- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
+
+To use this, assign this constant to the [`separator`](#separator) parameter.
+
+<h1></h1>
+
 ## `TextWrapper`
 ```py
 class TextWrapper:
+
     def __init__(
         self,
         width: Union[int, float] = 70,
         line_padding: Union[int, float] = 0,
-        method: Literal['mono', 'word'] = 'word',
+        mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
         fillchar: str = ' ',
         separator: Optional[Union[str, Iterable[str]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty: bool = True,
+        preserve_empty_lines: bool = True,
         minimum_width: bool = True,
+        drop_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None,
+        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -88,10 +107,10 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`method`**
-(Default: `'word'`) The wrapping method. Available options:
-- `'mono'` method wraps text character by character.
-- `'word'` method wraps text word by word.
+#### **`mode`**
+(Default: `'word'`) The wrapping mode. Available options:
+- `'mono'` make text wraps character by character.
+- `'word'` make text wraps word by word.
 
 <h1></h1>
 
@@ -133,7 +152,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty`**
+#### **`preserve_empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -144,6 +163,11 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
+#### **`drop_separator`**
+(Default: `False`) Removes the separator between more than one word at a time.
+
+<h1></h1>
+
 #### **`justify_last_line`**
 (Default: `False`) Determines whether the last line should also be justified
 (applies only to `fill-...` alignments).
@@ -170,6 +194,15 @@ If the function calculates only the width, it must return a single value of type
 
 > Note: All methods can be called outside the [`TextWrapper`](#textwrapper) like external functions.
 
+For example:
+```py
+>>> txtwrap.TextWrapper(20, placeholder='[...]').shorten("Hello World!")
+```
+is equivalent to:
+```py
+>>> txtwrap.shorten("Hello World!", 20, placeholder='[...]')
+```
+
 <h1></h1>
 
 #### **`copy`**
@@ -192,44 +225,56 @@ For example:
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
-- `'indiced'`: A set of indices marking the end of line (starting from `0`, like programming indices).
+- `'start_lines'`: A set of indices marking the start of line.
+- `'end_lines'`: A set of indices marking the end of line.
 
 For example:
 ```py
 >>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
 ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'indiced': {4}}
+>>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
+>>> info
+{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
+>>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum'
+>>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+'elit.'
 ```
 
 <h1></h1>
 
 #### **`align(text, return_details=False)`**
-Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along with its
-coordinates.
+Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
+with its coordinates.
 > Note: [`sizefunc`](#sizefunc) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
-- `'wrapped'`: The result from wrap.
-- `'indiced'`: The indices of line breaks.
-- `'size'`: The calculated text size.
+- `'wrapped'`: A list of wrapped text fragments.
+- `'start_lines'`: A set of indices marking the start of line.
+- `'end_lines'`: A set of indices marking the end of line.
+- `'size'`: A calculated text size.
 
 For example:
 ```py
 >>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'indiced': {2}, 'size': (18, 3)}
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
+>>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor'
+>>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc) (size or just length) must return `int`,
-not `float`!
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+(size or just length) must return `int`, not `float`!
 
 For example:
 ```py
@@ -273,12 +318,13 @@ def render_wrap(
     color: pygame.Color,
     background: Optional[pygame.Color] = None,
     line_padding: int = 0,
-    method: Literal['word', 'mono'] = 'word',
+    wrap_mode: Literal['word', 'mono'] = 'word',
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty: bool = True,
+    preserve_empty_lines: bool = True,
     minimum_width: bool = True,
+    drop_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -288,12 +334,13 @@ def render_wrap(
         text=text,
         width=width,
         line_padding=line_padding,
-        method=method,
+        mode=wrap_mode,
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty=preserve_empty,
+        preserve_empty_lines=preserve_empty_lines,
         minimum_width=minimum_width,
+        drop_separator=drop_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,

{txtwrap-2.3.2 → txtwrap-3.0.0}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', encoding='utf-8') as readme:
 
 setup(
     name='txtwrap',
-    version='2.3.2',
+    version='3.0.0',
     description='A tool for wrapping and filling text.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -13,14 +13,13 @@ setup(
     author_email='azzammuhyala@gmail.com',
     url='https://github.com/azzammuhyala/txtwrap',
     license='MIT',
-    python_requires='>=3.3',
+    python_requires='>=3.0',
     packages=find_packages(),
     include_package_data=True,
     keywords=['wrap', 'wrapper', 'wrapping', 'wrapped', 'text wrap', 'text wrapper', 'text wrapping', 'text wrapped'],
     classifiers=[
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Text Processing',
         'Topic :: Text Processing :: Filters'

txtwrap-3.0.0/txtwrap/__init__.py

@@ -0,0 +1,35 @@
+"""
+A tool for wrapping and filling text.
+"""
+
+# Supports only in Python>=3.0.0
+
+from . import constants as constants
+from . import identities as identities
+from . import wrapper as wrapper
+
+from .identities import __version__, __author__, __license__
+
+from .constants import (
+    LOREM_IPSUM_WORDS, LOREM_IPSUM_SENTENCES, LOREM_IPSUM_PARAGRAPHS,
+    SEPARATOR_WHITESPACE, SEPARATOR_ESCAPE
+)
+
+from .wrapper import (
+    TextWrapper,
+    sanitize, wrap, align, fillstr, shorten
+)
+
+__all__ = [
+    'LOREM_IPSUM_WORDS',
+    'LOREM_IPSUM_SENTENCES',
+    'LOREM_IPSUM_PARAGRAPHS',
+    'SEPARATOR_WHITESPACE',
+    'SEPARATOR_ESCAPE',
+    'TextWrapper',
+    'sanitize',
+    'wrap',
+    'align',
+    'fillstr',
+    'shorten'
+]

txtwrap-3.0.0/txtwrap/__init__.pyi

@@ -0,0 +1,30 @@
+# Define the packages
+
+from . import constants as constants
+from . import identities as identities
+from . import wrapper as wrapper
+
+# Define the main variables, functions, classes to be exported
+
+from .constants import (
+    LOREM_IPSUM_WORDS as LOREM_IPSUM_WORDS,
+    LOREM_IPSUM_SENTENCES as LOREM_IPSUM_SENTENCES,
+    LOREM_IPSUM_PARAGRAPHS as LOREM_IPSUM_PARAGRAPHS,
+    SEPARATOR_WHITESPACE as SEPARATOR_WHITESPACE,
+    SEPARATOR_ESCAPE as SEPARATOR_ESCAPE
+)
+
+from .identities import (
+    __version__ as __version__,
+    __author__ as __author__,
+    __license__ as __license__
+)
+
+from .wrapper import (
+    TextWrapper as TextWrapper,
+    sanitize as sanitize,
+    wrap as wrap,
+    align as align,
+    fillstr as fillstr,
+    shorten as shorten
+)

txtwrap-3.0.0/txtwrap/_utils.py

@@ -0,0 +1,34 @@
+import re
+
+pdict = type('pdict', (dict,), {
+    '__repr__': lambda self : '{}({})'.format(type(self).__name__, dict.__repr__(self)),
+    '__getattr__': lambda self, key: self.get(key, None),
+    '__setattr__': dict.__setitem__,
+    '__delattr__': dict.__delitem__
+})
+
+def align_left(aligned, text, width, text_width, offset_y):
+    aligned.append((0, offset_y, text))
+
+def align_center(aligned, text, width, text_width, offset_y):
+    aligned.append(((width - text_width) / 2, offset_y, text))
+
+def align_right(aligned, text, width, text_width, offset_y):
+    aligned.append((width - text_width, offset_y, text))
+
+def fillstr_left(justified_lines, text, width, text_width, fillchar):
+    justified_lines.append(text + fillchar * (width - text_width))
+
+def fillstr_center(justified_lines, text, width, text_width, fillchar):
+    extra_space = width - text_width
+    left_space = extra_space // 2
+    justified_lines.append(fillchar * left_space + text + fillchar * (extra_space - left_space))
+
+def fillstr_right(justified_lines, text, width, text_width, fillchar):
+    justified_lines.append(fillchar * (width - text_width) + text)
+
+hyphenate_parrent = r'''
+(?<=-)      # Positive lookbehind -> make sure there is a '-' before the current position
+(?=(?!-).)  # Positive lookahead -> make sure the character after is NOT '-' (avoid '--'), but still have one character
+'''
+split_hyphenated = re.compile(hyphenate_parrent, re.VERBOSE).split

txtwrap-3.0.0/txtwrap/constants.py

@@ -0,0 +1,33 @@
+LOREM_IPSUM_WORDS = 'Lorem ipsum odor amet, consectetuer adipiscing elit.'
+LOREM_IPSUM_SENTENCES = (
+    'Lorem ipsum odor amet, consectetuer adipiscing elit. In malesuada eros natoque urna felis diam aptent donec. Cubil'
+    'ia libero morbi fusce tempus, luctus aenean augue. Mus senectus rutrum phasellus fusce dictum platea. Eros a integ'
+    'er nec fusce erat urna.'
+)
+LOREM_IPSUM_PARAGRAPHS = (
+    'Lorem ipsum odor amet, consectetuer adipiscing elit. Nulla porta ex condimentum velit facilisi; consequat congue. '
+    'Tristique duis sociosqu aliquam semper sit id. Nisi morbi purus, nascetur elit pellentesque venenatis. Velit commo'
+    'do molestie potenti placerat faucibus convallis. Himenaeos dapibus ipsum natoque nam dapibus habitasse diam. Viver'
+    'ra ac porttitor cras tempor cras. Pharetra habitant nibh dui ipsum scelerisque cras? Efficitur phasellus etiam con'
+    'gue taciti tortor quam. Volutpat quam vulputate condimentum hendrerit justo congue iaculis nisl nullam.\n\nIncepto'
+    's tempus nostra fringilla arcu; tellus blandit facilisi risus. Platea bibendum tristique lectus nunc placerat id a'
+    'liquam. Eu arcu nisl mattis potenti elementum. Dignissim vivamus montes volutpat litora felis fusce ultrices. Vulp'
+    'utate magna nascetur bibendum inceptos scelerisque morbi posuere. Consequat dolor netus augue augue tristique cura'
+    'bitur habitasse bibendum. Consectetur est per eros semper, magnis interdum libero. Arcu adipiscing litora metus fr'
+    'ingilla varius gravida congue tellus adipiscing. Blandit nulla mauris nullam ante metus curae scelerisque.\n\nSem '
+    'varius sodales ut volutpat imperdiet turpis primis nullam. At gravida tincidunt phasellus lacus duis integer eros '
+    'penatibus. Interdum mauris molestie posuere nascetur dignissim himenaeos; magna et quisque. Dignissim malesuada et'
+    'iam donec vehicula aliquet bibendum. Magna dapibus sapien semper parturient id dis? Pretium orci ante leo, porta t'
+    'incidunt molestie. Malesuada dictumst commodo consequat interdum nisi fusce cras rhoncus feugiat.\n\nHimenaeos mat'
+    'tis commodo suspendisse maecenas cras arcu. Habitasse id facilisi praesent justo molestie felis luctus suspendisse'
+    '. Imperdiet ipsum praesent nunc mauris mattis curabitur. Et consectetur morbi auctor feugiat enim ridiculus arcu. '
+    'Ultricies magna blandit eget; vivamus sollicitudin nisl proin. Sollicitudin sociosqu et finibus elit vestibulum sa'
+    'pien nec odio euismod. Turpis eleifend amet quis auctor cursus. Vehicula pharetra sapien praesent amet purus ante.'
+    ' Risus blandit cubilia lorem hendrerit penatibus in magnis.\n\nAmet posuere nunc; maecenas consequat risus potenti'
+    '. Volutpat leo lacinia sapien nulla sagittis dignissim mauris ultrices aliquet. Nisi pretium interdum luctus donec'
+    ' magna suscipit. Dapibus tristique felis natoque malesuada augue? Justo faucibus tincidunt congue arcu sem; fusce '
+    'aliquet proin. Commodo neque nibh; tempus ad tortor netus. Mattis ultricies nec maximus porttitor non mauris?'
+)
+
+SEPARATOR_WHITESPACE = (' ', '\t', '\n', '\r', '\v', '\f')
+SEPARATOR_ESCAPE = SEPARATOR_WHITESPACE + ('\a', '\b', '\0')

txtwrap-3.0.0/txtwrap/constants.pyi

@@ -0,0 +1,8 @@
+from typing import Tuple
+
+LOREM_IPSUM_WORDS: str
+LOREM_IPSUM_SENTENCES: str
+LOREM_IPSUM_PARAGRAPHS: str
+
+SEPARATOR_WHITESPACE: Tuple[str]
+SEPARATOR_ESCAPE: Tuple[str]

txtwrap-3.0.0/txtwrap/identities.py

@@ -0,0 +1,3 @@
+__version__ = '3.0.0'
+__author__ = 'azzammuhyala'
+__license__ = 'MIT'