Metadata-Version: 2.1
Name: scottbrian_utils
Version: 1.0.0
Summary: Print header/trailer utilities
Home-page: https://github.com/ScottBrian/scottbrian_utils.git
Author: Scott Tuttle
License: UNKNOWN
Project-URL: Source, https://github.com/ScottBrian/scottbrian_utils.git
Description: ================
        scottbrian-utils
        ================
        
        Intro
        =====
        
        With **@time_box**, you can decorate a function to be sandwiched between start
        time and end time messages like this:
        
        >>> from scottbrian_utils.time_hdr import time_box
        
        >>> @time_box
        ... def func2() -> None:
        ...      print('2 * 3 =', 2*3)
        
        >>> func2()
        <BLANKLINE>
        **********************************************
        * Starting func2 on Mon Jun 29 2020 18:22:50 *
        **********************************************
        2 * 3 = 6
        <BLANKLINE>
        ********************************************
        * Ending func2 on Mon Jun 29 2020 18:22:51 *
        * Elapsed time: 0:00:00.001204             *
        ********************************************
        
        .. image:: https://img.shields.io/badge/security-bandit-yellow.svg
            :target: https://github.com/PyCQA/bandit
            :alt: Security Status
        
        .. image:: https://readthedocs.org/projects/pip/badge/?version=stable
            :target: https://pip.pypa.io/en/stable/?badge=stable
            :alt: Documentation Status
        
        
        The flower_box.py module contains:
        
        1. print_flower_box_msg function - takes one of more lines of text as input
           and prints them inside a flower box (asterisks) as a visual aid for finding
           the text on the console or in a log.
           
        The time_hdr.py module contains:
        
        1. StartStopHeader class - has two functions that will respectively print
           a starting time message in a flower box, and an ending time and elapsed
           wall clock time message in a flower box.
        2. time_box decorator - wraps a function and uses the StartStopHeader to
           print the starting and ending time headers.
        
        
        
        
        
        Installation
        ============
        
        Linux:
        
        ``pip install scottbrian-utils``
        
        
        Usage examples:
        ===============
        
        flower_box example
        ------------------
        
        print a single line message in a flower box
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        >>> from scottbrian_utils.flower_box import print_flower_box_msg
        >>> print_flower_box_msg('This is my test message')
        ***************************
        * This is my test message *
        ***************************
        
        print a two line message in a flower box
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        >>> from scottbrian_utils.flower_box import print_flower_box_msg
        >>> msg_list = ['This is my first line test message', '   and my second line']
        >>> print_flower_box_msg(msg_list)
        **************************************
        * This is my first line test message *
        *    and my second line              *
        **************************************
        
        time_box decorator example
        --------------------------
        
        wrap a function with time_box
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        >>> from scottbrian_utils.time_hdr import time_box
        
        >>> @time_box
        ... def func2():
        ...      print('2 * 3 =', 2*3)
        
        >>> func2()
        **********************************************
        * Starting func2 on Tue May 12 2020 20:35:06 *
        **********************************************
        2 * 3 = 6
        ********************************************
        * Ending func2 on Tue May 12 2020 20:35:07 *
        * Elapsed time: 0:00:00.000196             *
        ********************************************
        
        Development setup
        =================
        
        See tox.ini
        
        Release History
        ===============
        
        * 1.0.0
            * Initial release
        
        Meta
        ====
        
        Scott Tuttle
        
        Distributed under the MIT license. See ``LICENSE`` for more information.
        
        
        Contributing
        ============
        
        1. Fork it (<https://github.com/yourname/yourproject/fork>)
        2. Create your feature branch (`git checkout -b feature/fooBar`)
        3. Commit your changes (`git commit -am 'Add some fooBar'`)
        4. Push to the branch (`git push origin feature/fooBar`)
        5. Create a new Pull Request
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
