Metadata-Version: 2.1
Name: boxprint
Version: 0.0.6
Summary: A small package for printing boxes
Home-page: https://github.com/yuzuquats/pyboxprint
Author: James Kao
Author-email: james.l.kao@example.com
License: UNKNOWN
Description: # Boxprint
        
        A small package to print boxes
        
        ## Usage
        
        ```python
        from boxprint import bprint
        
        bprint("hello world")
        ```
        ```
        ╭──────────────────────────────────────────────────────────────────────────────╮
        │ Hello World                                                                  │
        ╰──────────────────────────────────────────────────────────────────────────────╯
        ```
        
        ## Configurations
        
        ```python
        from boxprint import bprint, BoxTypes
        
        """
        @param width
          Max width of the box
        @param box_type
          The type of the box (LIGHT, HEAVY, DOUBLE, ROUND)
        @param print_func
          The print function to use
        """
        bprint("hello_world", width=40, box_type=BoxTypes.HEAVY, print_func=print)
        bprint("Text\nWith\nMultiple\nLines")
        ```
        ```
        ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
        ┃ Hello World                          ┃
        ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
        
        ╭──────────────────────────────────────────────────────────────────────────────╮
        │ Text                                                                         │
        │ With                                                                         │
        │ Multiple                                                                     │
        │ Lines                                                                        │
        ╰──────────────────────────────────────────────────────────────────────────────╯
        ```
        
        ```python
        buf = []
        def print_to_buf(string):
          buf.append(string)
        
        # Boxes apply 2 spaces of padding to the left and right width = (default=80 - 2*2)
        bprint("Inner Box", width=76, print_func=print_to_buf)
        inner_box = "".join(buf)
        
        bprint(f"Outer box\n{inner_box}")
        ```
        ```
        ╭──────────────────────────────────────────────────────────────────────────────╮
        │ Outer box                                                                    │
        │ ╭──────────────────────────────────────────────────────────────────────────╮ │
        │ │ Inner Box                                                                │ │
        │ ╰──────────────────────────────────────────────────────────────────────────╯ │
        ╰──────────────────────────────────────────────────────────────────────────────╯
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
