Metadata-Version: 1.0
Name: pyprel
Version: 2016.02.01.2018
Summary: Python print elegant
Home-page: https://github.com/wdbm/pyprel
Author: Will Breaden Madden
Author-email: w.bm@cern.ch
License: GPLv3
Description: pyprel
        ======
        
        Python print elegant
        
        introduction
        ============
        
        This module provides Python rendering functionality. It can render a
        dictionary such that it is displayed with indentations for illustration
        of hierarchy:
        
        ::
        
            sample information:
              name: ttH
              generator: pythia8
              cross section: 0.055519
              variables:
                zappo_n: 9001
                trk_n: 147
              number of events: 124883
              k factor: 1.0201
              ID: 169888
        
        It can render and display logos:
        
        ::
        
                              ____      _            _____ _                                
                             / ___|___ | | ___  _ __|  ___| | _____      __                 
                            | |   / _ \| |/ _ \| '__| |_  | |/ _ \ \ /\ / /                 
                            | |__| (_) | | (_) | |  |  _| | | (_) \ V  V /                  
                             \____\___/|_|\___/|_|  |_|   |_|\___/ \_/\_/               
        
        It can center blocks of text for terminal output (such as in a way shown
        for the logo above). It can render segment displays:
        
        ::
        
             _     _  _     _  _  _  _  _ 
            | |  | _| _||_||_ |_   ||_||_|
            |_|  ||_  _|  | _||_|  ||_| _|
        
        It can render and display tables of various specified widths and column
        widths with various text wrapping features and delimiters:
        
        ::
        
            |---------------------------------------------------|
            |heading 1                |heading 2                |
            |---------------------------------------------------|
            |some text                |some more text           |
            |---------------------------------------------------|
            |lots and lots and lots   |some more text           |
            |and lots and lots of text|                         |
            |---------------------------------------------------|
        
        ::
        
                                     |---------------------------|                          
                                     |heading 1    |heading 2    |                          
                                     |---------------------------|                          
                                     |some text    |some more    |                          
                                     |             |text         |                          
                                     |---------------------------|                          
                                     |lots and lots|some more    |                          
                                     |and lots and |text         |                          
                                     |lots and lots|             |                          
                                     |of text      |             |                          
                                     |---------------------------|                         
        
        ::
        
            ||----------------------------------------------------||
            ||heading 1                ||heading 2                ||
            ||----------------------------------------------------||
            ||some text                ||some more text           ||
            ||----------------------------------------------------||
            ||lots and lots and lots   ||some more text           ||
            ||and lots and lots of text||                         ||
            ||----------------------------------------------------||
        
        ::
        
            |-----------------------------------------------------------------------------|
            |heading 1                |heading 2                |heading 3                |
            |-----------------------------------------------------------------------------|
            |some text                |some more text           |even more text           |
            |-----------------------------------------------------------------------------|
            |lots and lots and lots   |some more text           |some more text           |
            |and lots and lots of text|                         |                         |
            |-----------------------------------------------------------------------------|
        
        ::
        
            |---------------------------------------------------------------------------|
            |heading 1         |heading 2         |heading 3         |heading 4         |
            |---------------------------------------------------------------------------|
            |some text         |some more text    |even more text    |yeah more text    |
            |---------------------------------------------------------------------------|
            |lots and lots and |some more text    |some more text    |some more text    |
            |lots and lots and |                  |                  |                  |
            |lots of text      |                  |                  |                  |
            |---------------------------------------------------------------------------|
        
        It can provide color palettes, extend them and save images of them.
        Color palettes available can be viewed by saving images of them:
        
        .. code:: Python
        
            pyprel.save_images_of_palettes()
        
        A palette can be loaded using its name:
        
        .. code:: Python
        
            pyprel.access_palette(name = "palette1")
        
        A palette of colors can be extended to a required number of colors:
        
        .. code:: Python
        
            colors_1_extended = extend_palette(
                colors                          = colors_1,
                minimum_number_of_colors_needed = 15
            )
        
        prerequisites
        =============
        
        pyfiglet
        --------
        
        .. code:: Bash
        
            sudo pip install pyfiglet
        
        references
        ==========
        
        -  C. A. Brewer, M. Harrower ColorBrewer.org: An Online Tool for
           Selecting Colour Schemes for Maps, The Cartographic Journal, 40 (1),
           27--37 (01 June 2003)
        
        palettes
        ========
        
        |image0| |image1| |image2| |image3| |image4| |image5| |image6| |image7|
        |image8| |image9| |image10| |image11| |image12| |image13| |image14|
        |image15| |image16| |image17| |image18| |image19| |image20| |image21|
        
        .. |image0| image:: images/palette_1.png
        .. |image1| image:: images/palette_2.png
        .. |image2| image:: images/palette_3.png
        .. |image3| image:: images/palette_4.png
        .. |image4| image:: images/palette_5.png
        .. |image5| image:: images/palette_6.png
        .. |image6| image:: images/palette_7.png
        .. |image7| image:: images/palette_8.png
        .. |image8| image:: images/palette_9.png
        .. |image9| image:: images/palette_10.png
        .. |image10| image:: images/palette_11.png
        .. |image11| image:: images/palette_12.png
        .. |image12| image:: images/palette_13.png
        .. |image13| image:: images/palette_14.png
        .. |image14| image:: images/palette_15.png
        .. |image15| image:: images/palette_16.png
        .. |image16| image:: images/palette_17.png
        .. |image17| image:: images/palette_18.png
        .. |image18| image:: images/palette_19.png
        .. |image19| image:: images/palette_20.png
        .. |image20| image:: images/palette_21.png
        .. |image21| image:: images/palette_22.png
        
Platform: UNKNOWN
