Metadata-Version: 1.1
Name: reportng
Version: 0.39
Summary: reportng is a simple python module that allows one to create beautiful yet simple Bootstrap 4 html reports. Reportng is capable of with any string type output that is generated by python.
Home-page: https://github.com/securisec/reportng
Author: securisec
Author-email: UNKNOWN
License: UNKNOWN
Download-URL: https://github.com/securisec/reportng/archive/0.39.tar.gz
Description: reportng
        ========
        
        |Build Status| |Documentation| |Read the Docs| |PyPI| |PyPI version|
        |repo size| |Twitter Follow|
        
        **reportng** is a simple python module that allows one to create
        beautiful yet simple Bootstrap 4 html reports. Reportng is capable of
        with any string type output that is generated by python. Use cases are
        building beautiful output from tools/scripts or just python in general
        
        Currently, ``reportng`` supports the following:
        
        -  Search and highlight (supports regex) and hit count
        -  Self populating dropdown menu for report sections.
        -  Code sections with lexing
        -  Asciinema integration
        -  Image carousels with captions
        -  Stackable cards
        -  Social integrated footers
        -  Progress bar
        -  Tables
        
        Installation
        ------------
        
            ``pip install -U reportng``
        
        Documentation
        -------------
        
        `Documentation is on readthedocs`_
        
        Example
        -------
        
        `See on the documentation page`_
        
        Main methods
        ~~~~~~~~~~~~
        
        All the usable methods start with the prefix *report* -
        
        **report_header** is used to create the header section of the report and
        controls things like theme and highlight color.
        |image7|
        
        **report_section** is used to create the main body/section for reportng.
        This method supports *pre* tags by default, but *p* can be used also.
        |image8|
        
        **report_image_carousel** is used to add an image carousel.
        It takes \*args and multiple images can be passed to it.
        |image9|
        
        **report_asciinema** is used to add an asciinema. At the
        moment, it can use take a valid asciinema url. Example
        ``https://asciinema.org/a/117928``
        |image10|
        
        **report_code_section**
        is used to add code that is lexed and highlighted using highlight.js
        |image11|
        
        **report_captions** is used to add a simple *p* tag. Useful
        to add information below sections
        
        **report_cards** is used to create
        stackable cards
        |image12|
        
        **report_table** is used to create tables
        |image13|
        
        .. _Documentation is on readthedocs: http://reportng.readthedocs.io/en/latest/
        .. _See on the documentation page: http://reportng.readthedocs.io/en/latest/#example
        
        .. |Build Status| image:: https://travis-ci.org/securisec/reportng.svg?branch=master
           :target: https://travis-ci.org/securisec/reportng
        .. |Documentation| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
           :target: http://reportng.readthedocs.io/en/latest/
        .. |Read the Docs| image:: https://img.shields.io/readthedocs/reportng.svg
           :target: http://reportng.readthedocs.io/en/latest/
        .. |PyPI| image:: https://img.shields.io/pypi/v/reportng.svg
           :target: https://pypi.python.org/pypi/reportng
        .. |PyPI version| image:: https://img.shields.io/pypi/pyversions/reportng.svg
           :target: https://pypi.python.org/pypi/reportng
        .. |repo size| image:: https://img.shields.io/github/repo-size/securisec/reportng.svg
        .. |Twitter Follow| image:: https://img.shields.io/twitter/follow/securisec.svg?style=social&label=Follow
           :target: https://twitter.com/securisec
        .. |image7| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_header.png
        .. |image8| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_section.png
        .. |image9| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_image_carousal.gif
        .. |image10| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_asciinema.png
        .. |image11| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_code.png
        .. |image12| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_cards.png
        .. |image13| image:: https://github.com/securisec/reportng/blob/master/sample%20report/report_table.png
Keywords: report,reporting,bootstrap
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Natural Language :: English
