Metadata-Version: 1.1
Name: riceprint
Version: 1.5.6
Summary: OS-agnostic colored & custom Python console print() functions.
Home-page: https://github.com/ssriceboat/riceprint
Author: Kevin Sacca
Author-email: ssriceboat@gmail.com
License: MIT
Project-URL: Documentation, https://riceprint.readthedocs.io/en/latest/
Description: riceprint
        =========
        
        |shield1| |shield2| |shield3| |shield4| |shield5|
        
        .. |shield1| image:: https://img.shields.io/github/release/ssriceboat/riceprint.svg?color=blue
           :width: 20%
        
        .. |shield2| image:: https://img.shields.io/badge/Python-%3E=3.5-blue.svg?color=e6ac00
           :width: 20%
        
        .. |shield3| image:: https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg
           :width: 24%
        
        .. |shield4| image:: https://img.shields.io/github/license/ssriceboat/riceprint.svg?color=blue
           :width: 20%
        
        .. |shield5| image:: https://img.shields.io/pypi/dm/riceprint.svg?color=blueviolet
           :width: 20%
        
        |gifdemo|
        
        .. |gifdemo| image:: https://github.com/ssriceboat/riceprint/raw/master/screenshots/demo.gif
           :width: 60%
        
        About
        =====
        
        Author: Kevin Sacca ssriceboat@gmail.com
        
        Simple Python package to replace the built-in print() function. This
        module contains functions for colored print statements and temporary
        print statements. Also contained in this package is a full-featured
        example usage of this package's tprint() function to create a beautiful
        progressbar in the console.
        
        Works on Linux, macOS, Windows. For Windows, install colorama. (https://pypi.org/project/colorama/)
        
        License
        =======
        
        MIT License
        
        Copyright (c) 2019 ssriceboat
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be included
        in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        Installation
        ============
        
        Using pip
        ~~~~~~~~~
        
        .. code:: bash
        
            pip install riceprint
        
        Usage:
        ======
        
        After you have installed the package, check that its working by running
        the module directly. This will show you all the vailable print colors:
        
        .. code:: bash
        
            cd /path/to/riceprint-package/src/riceprint/
            python riceprint.py
        
        Below is an example of how you can use the functions:
        
        .. code:: python
        
            from riceprint import tprint, pprint, progressbar
            import time
        
            # Simple pprint, tprint demo
            print('This is not using riceprint.')
            pprint('This is using riceprint. (Same unless you add some spice)')
            pprint('This is using riceprint with style.', 'c')
            tprint('This message will be erased by the next line.', 'b')
            tprint('This message overwrites the previous tprint and will also be overwritten.', 'r')
            pprint('This message overwrites the previous tprint and is permanent.', 'g')
        
            # Overwriting previous messages, like status changes.
            message = 'This is an example of something you can do with tprint().'
            elements = message.split(' ')
            some_colors = ['r', 'g', 'b', 'c', 'm', 'y', 'k', 'w', 'dr', 'dk', 'dc']
            for i in range(len(elements)):
               msg = ''
               for y in range(i + 1):
                  msg += elements[y] + ' '
        
               color = some_colors[i]
        
               tprint(msg, color)
               time.sleep(0.25)
        
            # Progress bar example
            for x in range(100 + 1):
               progressbar(x, 100, color='dg', char='\u2587', lend='|', rend='|')
               time.sleep(0.01)
        
            # Adding keep=True here will leave the completed progressbar in the console
            progressbar(x, 100, color='dg', char='\u2587', lend='|', rend='|', keep=True)
        
            pprint('Done! I hope you use this package!', 'dm')
        
        
Keywords: print console terminal shell python pprint color progress bar
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
