Metadata-Version: 1.1
Name: pretty-print-dictionary
Version: 1.1.1
Summary: A tool for showing dictionary objects in a more human-readable format.
Home-page: https://github.com/kinghadi/Python-PrettyPrintDictionary
Author: Hadi Sinaee, Sharif University of Technology
Author-email: sinaee@ce.sharif.ir
License: GNU GPL
Description: Python-PrettyPrintDictionary
        ============================
        
        Prints Dictionary key-values in a human readable manner.
        
        <h2>What it is?</h2>
        Suppose you have the following dictionary:
        ```
        dict_1 = {'a': 0, '1': {1: 'c', 2: 'd'}, '2': [1, 2, 3, 4, 5, 6]}
        ```
        When you print this on the console you will have this:
        ```
        >>> {'a': 0, '1': {1: 'c', 2: 'd'}, '2': [1, 2, 3, 4, 5, 6]}
        ```
        What if you have a very larger dictionary of things that each key has an iterable object, i.e dictionary, list, ...? How does it look like?
        
        Suppose you have the following dictionary:
        ```
        dict_1 = {'a': 0, '1': {1: {'abc': [1, 2, 3, 4, 5, 6], 'efg': [7, 8, 9, 10, 100]},
                                2: {'1': {1: 'abc', 2: 'efg'}, '2': {3: 'abc'}}}, '2': [1, 2, 3, 4, 5, 6]}
        ```
        if you print if normally it will be this:
        ```
        {'a': 0, '1': {1: {'abc': [1, 2, 3, 4, 5, 6], 'efg': [7, 8, 9, 10, 100]}, 2: {'1': {1: 'abc', 2: 'efg'}, '2': {3: 'abc'}}}, '2': [1, 2, 3, 4, 5, 6]}
        ```
        But if you use this lib it would be this(this is PyCharm Console):
        
        <img src="http://s3.postimg.org/575oxpv7n/git_pretty_print_dict01.jpg"  />
        
        <h2>Usage</h2>
        
        Simply import the <b>PrettyDict</b> from <b>pretty_dictionary</b> module from <b>pretty_print_dictionary</b> package
        ```
        from pretty_print_dictionary.pretty_dictionary import PrettyDict
        ```
        
        Create your own dictionary.
        ```
        my_dictionary = {0:[1,2,3], 1:['a','b']}
        ```
        
        Create a class of <b>PrettyDict</b> and set your dictionary as its argument.
        ```
        pd = PrettyDict(my_dictionary)
        ```
        
        Call the <b>ppd</b>(Pretty Print Dictionary) method to print the dictionary
        ```
        pd.ppd()
        ```
        
        <h4>Keywords</h4>
        there is 4 keywords for this module:
        
        <table >
        <tr>
        <th>
        keyword
        </th>
        <th>
        comments
        </th>
        <th>
        value(s)
        </th>
        
        </tr>
        
        
        <tr>
        <td>fill_char_width</td> 
        <td>specifies number of chars to be indented for each level.</td>
        <td> int </td>
        </tr>
        
        <tr>
        <td>fill_char</td>
        <td>specifies the char to be indented for each level.</td>
        <td> str</td>
        </tr>
        
        <tr>
        <td>order</td>
        <td>specifies the color style for output.</td>
        <td>'full', 'even', 'random'</td>
        </tr>
        
        <tr>
        <td>show_level</td>
        <td>prints the level number next to the key element</td>
        <td>'show', 'hide'</td>
        </tr>
        </table>
        
        
Keywords: dict dictionary pretty print
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
