# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-json2html
VERSION=		1.3.0
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		JSON to HTML Table Representation (3.11)
SDESC[v12]=		JSON to HTML Table Representation (3.12)
HOMEPAGE=		https://github.com/softvar/json2html
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/j/json2html
DISTFILE[1]=		json2html-1.3.0.tar.gz:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

DISTNAME=		json2html-1.3.0

GENERATED=		yes

[PY311].USES_ON=			python:v11,sutools

[PY312].USES_ON=			python:v12,sutools

[FILE:2731:descriptions/desc.single]
json2html
=========

Python wrapper to convert JSON into a human readable HTML Table
representation.

|Latest Version| |Downloads| |Build|

Features
--------

* User friendly tablular fomat, easy to read and share.
* If value of the key is array of objects and all the keys are same(value
of the key is a dict of list), the module will club by default. Eg.

.. code-block:: bash

	input = {
		"sampleData": [{
			"a":1, "b":2, "c":3
		}, {
			"a":5, "b":6, "c":7
		}]
	}

	will create only one row combining the results. This feature can be turned
off by explicitly passing an argument ``clubbing = False``.

* Generated table can be provided some attributes explicitly. Eg. giving an
id, class or any ``data-*`` attribute.
* Python 3 compatible

Live Demo
----------

[Click here] for the online demo.

List of valid arguments
-----------------------

``json2html.convert`` - The module's convert method accepts the following
arguments:

===================== ================
Argument              Description
--------------------- ----------------
`json`                a valid JSON; This can either be a string in valid
JSON format or a python object that is either dict-like or list-like at the
top level.
--------------------- ----------------
`table_attributes`    e.g. pass `id="info-table"` or
`class="bootstrap-class"`/`data-*` to apply these attributes to the
generated table
--------------------- ----------------
`clubbing`            turn on[default]/off clubbing of list with same keys
of a dict / Array of objects with same key
--------------------- ----------------
`encode`              turn on/off[default] encoding of result to escaped
html, compatible with any browser
--------------------- ----------------
`escape`              turn on[default]/off escaping of html tags in text
nodes (prevents XSS attacks in case you pass untrusted data to json2html)
===================== ================

Installation
------------

.. code-block:: bash

	$ pip install json2html

Or, Download [here] and run `python setup.py install` after changing
directory to `/json2html`

Example Usage
-------------

**Example 1:** Basic usage

.. code-block:: python

	from json2html import *
	input = {
		"name": "json2html",
		"description": "Converts JSON to HTML tabular representation"
	}
	json2html.convert(json = input)

Output:

.. code-block:: bash

	<table
border="1"><tr><th>name</th><td>json2html</td></tr><tr><th>description</th><td>converts
JSON to HTML tabular representation</td></tr></table>

============ ========================================================
name         json2html
------------ --------------------------------------------------------
description  Converts JSON to HTML tabular representation


[FILE:101:distinfo]
8951a53662ae9cfd812685facdba693fc950ffc1c1fd1a8a2d3cf4c34600689c         6977 json2html-1.3.0.tar.gz