Metadata-Version: 2.4
Name: jsonl2html
Version: 0.2.0
Summary: A tool to convert JSONL to HTML
Author-email: Adamenko Pavel <padamenko@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/padap/jsonl2html
Project-URL: Bug Tracker, https://github.com/padap/jsonl2html/issues
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6
Description-Content-Type: text/markdown


# JSONL to HTML Converter

A simple command-line tool to convert JSONL (JSON Lines) files into HTML format. This tool is designed to facilitate the visualization of structured data stored in JSONL format.

# Usage
### Bash
`jsonl2html some_file.jsonl`
Will create `some_file.html` vizualization

`jsonl2html --help`
Read the documentation

`jsonl2html some_file.jsonl --index_column=some_column`
Will create vizualization indexed by `some_column`

### Python
```python
from jsonl2html import convert_jsonl_to_html
convert_jsonl_to_html(fn_input = "examples/small.jsonl",
index_column = 'auto', 
fn_output = "auto", 
additional_table_content = {"content": "value"}
)
```

## Features

- Convert JSONL files to HTML format using a customizable template.
- Optionally add an index based on a specified column in the JSONL file.
- Easy to use with a command-line interface.

## Installation

You can install the package locally using pip. Clone this repository and run:

```bash
pip install -e .
```

## Build from sources

```bash
python setup.py sdist bdist_wheel
pip install {path_to_package}
```

## Issues
 - add list normal vizualization
 - fix problem with double click at some line
 - add UnicodeParser invert index and aggregated statistic
 - add search


## ToDo
- fix logger redirect to stdout other's logs
- add .json as input format
- load to pip registry
- add normal examples
- add enable/disable markdown hint for some field
