vkBeautify

Python plugin to pretty-print or minify text in following formats:

• XML
• JSON
• CSS

Version - 0.3.0

Copyright (c) 2016 Vadim Kiryukhin ( vkiryukhin @ gmail.com )

License: MIT: http://www.opensource.org/licenses/mit-license.php

Installation

        pip install vkbeautify

Pretty print

        vkbeautify.xml( src [,dest [,tab_size]);
        vkbeautify.json(src [,dest [,tab_size]);
        vkbeautify.css( src [,dest [,tab_size]);


        @src:       XML string or path to XML file to beautify;
        @dest:      path to file to save beautified data (optional)
        @tab_size:  number of white spaces to shift (optional; default is 4)

        @return:  - string (if @dest is not provided)
                  - int (length of saved file) if @dest is provided

Minify

        vkbeautify.xml.min( src [,dest [,preserve_comments]]);
        vkbeautify.json.min(src [,dest]);
        vkbeautify.css.min( src [,dest [,preserve_comments]]);

        @src:   XML string or path to XML file to minify;
        @dest:  path to file to save beautified data (optional)
        @preserve_comments: bool (optional, default is True);
                            Set this flag to False to remove comments from @src

        @return:  - string (if @dest is not provided)
                  - int (length of saved file) if @dest is provided

Examples

import vkbeautify as vkb

vkb.xml(text)
vkb.xml(text, 'path/to/dest/file')
vkb.xml('path/to/src/file')
vkb.xml('path/to/src/file', 'path/to/dest/file')
vkb.xml('path/to/src/file', 8)
vkb.xml('path/to/src/file', 'path/to/dest/file', 5)


vkb.xml.min(text)
vkb.xml.min(text, 'path/to/dest/file')
vkb.xml.min('path/to/src/file')
vkb.xml.min('path/to/src/file', 'path/to/dest/file')
vkb.xml.min('path/to/src/file', False)
vkb.xml.min('path/to/src/file', 'path/to/dest/file', False)

To play with this plugin in UNIX terminal use test/app.py application

usage: app.py -i <inputfile> -o <outputfile> -a <action>
       to beautify: no  <action>
       to minify:   set <action> to min

you can use demo files from the package:
basic.xml,  basic.min.xml
basic.json, basic.min.json
basic.css,  basic.min.css

Example:

python3 app.py -i basic.min.json                   # beautify file and print in terminal
python3 app.py -i basic.min.json -o result.json    # beautify file and save in file

python3 app.py -i basic.json -a min                 # minify file and print in terminal
python3 app.py -i basic.json -o result.json -a min  # minify file and save in file