txtwrap 2.3.2__tar.gz → 3.0.1__tar.gz

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

@@ -1,19 +1,20 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 2.3.2
+Version: 3.0.1
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
 Author-email: azzammuhyala@gmail.com
 License: MIT
+Project-URL: Source, https://github.com/azzammuhyala/txtwrap
+Project-URL: Bug Tracker, https://github.com/azzammuhyala/txtwrap/issues
 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
@@ -23,25 +24,28 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: project-url
 Dynamic: requires-python
 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.1** <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)
+- [`SEPARATOR_ESCAPE`](#separators)
+- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
+- [`sanitize`](#sanitizetext) (🛠️ Fixed)
+- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
+- [`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 +57,10 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 
 <h1></h1>
 
-## Lorem ipsum
+## Constants
+_File: **txtwrap.constants**_
+
+### Lorem ipsum
 ```py
 LOREM_IPSUM_WORDS
 LOREM_IPSUM_SENTENCES
@@ -66,24 +73,41 @@ 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`
+_File: **txtwrap.wrapper**_
+
 ```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 +140,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 +185,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 +196,11 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
+#### **`drop_separator`**
+(Default: `False`) Removes excess separators from between words one 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,20 +227,29 @@ 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`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`sanitize(text)`**
 Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
+character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
 
 For example:
 ```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
+>>> txtwrap.sanitize("\tHello \nWorld!\r ")
 'Hello World!'
 ```
 
@@ -220,48 +258,64 @@ 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 list of indices marking the start of line.
+- `'end_lines'`: A list 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}}
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing 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 list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
+- `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_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)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> aligned_info['wrapped'][end_lines[0] - 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
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -278,7 +332,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 
@@ -301,12 +355,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 +371,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.1}/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.1** <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)
+- [`SEPARATOR_ESCAPE`](#separators)
+- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
+- [`sanitize`](#sanitizetext) (🛠️ Fixed)
+- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
+- [`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,10 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 
 <h1></h1>
 
-## Lorem ipsum
+## Constants
+_File: **txtwrap.constants**_
+
+### Lorem ipsum
 ```py
 LOREM_IPSUM_WORDS
 LOREM_IPSUM_SENTENCES
@@ -38,24 +43,41 @@ 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`
+_File: **txtwrap.wrapper**_
+
 ```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 +110,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 +155,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 +166,11 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
+#### **`drop_separator`**
+(Default: `False`) Removes excess separators from between words one 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,20 +197,29 @@ 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`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`sanitize(text)`**
 Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
+character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
 
 For example:
 ```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
+>>> txtwrap.sanitize("\tHello \nWorld!\r ")
 'Hello World!'
 ```
 
@@ -192,48 +228,64 @@ 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 list of indices marking the start of line.
+- `'end_lines'`: A list 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}}
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing 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 list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
+- `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_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)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> aligned_info['wrapped'][end_lines[0] - 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
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -250,7 +302,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 
@@ -273,12 +325,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 +341,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.1}/setup.py

@@ -1,26 +1,29 @@
 from setuptools import find_packages, setup
 
-with open('README.md', encoding='utf-8') as readme:
-    long_description = readme.read()
+with open('README.md', 'r', encoding='utf-8') as file:
+    long_description = file.read()
 
 setup(
     name='txtwrap',
-    version='2.3.2',
+    version='3.0.1',
     description='A tool for wrapping and filling text.',
     long_description=long_description,
     long_description_content_type='text/markdown',
     author='azzammuhyala',
     author_email='azzammuhyala@gmail.com',
     url='https://github.com/azzammuhyala/txtwrap',
+    project_urls={
+        'Source': 'https://github.com/azzammuhyala/txtwrap',
+        'Bug Tracker': 'https://github.com/azzammuhyala/txtwrap/issues'
+    },
     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.1/txtwrap/__init__.py

@@ -0,0 +1,38 @@
+"""
+A tool for wrapping and filling text.
+
+See txtwrap module documentation on [GitHub](https://github.com/azzammuhyala/txtwrap) or on
+[PyPi](https://pypi.org/project/txtwrap) for details.
+"""
+
+# 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'
+]