html-to-json

library3.0.0pypypi✓ verified 85d ago

The `html-to-json` Python library, currently at version 2.0.0, provides functionality to convert HTML strings into a JSON representation. It also includes intelligent conversion for HTML tables. The project is currently in maintenance mode, with the author seeking sponsorship for active development and ongoing upkeep.

serialization data

pip install html-to-json

github ↗package ↗docs ↗changelog ↗

INSTALL

IMPORT

SIG · HTML-TO-JSON

html-to-json

serializationpythonv3.0.0

Install

1.8s avg

Import

481ms

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v3.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.488s · 19.2MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 1.8s · import 0.475s · 20MB

17MB installed

● package 17MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

html_to_json

✓ import html_to_json

This quickstart demonstrates how to convert a basic HTML string into JSON using the `html_to_json.convert` function. It also shows how to use the `capture_element_values` and `capture_element_attributes` parameters to control the output format.

import html_to_json html_string = """<head> <title>Test site</title> <meta charset="UTF-8"> <p>This is some <b>bold</b> text.</p> <table> <thead> <tr><th>Header 1</th><th>Header 2</th></tr> </thead> <tbody> <tr><td>Data 1</td><td>Data 2</td></tr> </tbody> </table> </head>""" # Convert HTML to JSON output_json = html_to_json.convert(html_string) print(output_json) # Convert HTML to JSON without capturing element values output_no_values = html_to_json.convert(html_string, capture_element_values=False) print(output_no_values) # Convert HTML to JSON without capturing element attributes output_no_attributes = html_to_json.convert(html_string, capture_element_attributes=False) print(output_no_attributes)

Debug

Known issues

maintenanceThe library is currently in a maintenance-only state. The author has indicated that active development requires sponsorship. Users should be aware that new features or rapid bug fixes may not be prioritized without community support.

fix

Consider contributing to the project or sponsoring the author for continued development.

affects: 2.0.0+

gotchaWhen upgrading from versions prior to 2.0.0, new parameters `capture_element_values` and `capture_element_attributes` were introduced to the `convert` function. While they default to `True`, explicitly setting them might be necessary to ensure consistent output if your downstream code relies on a specific JSON structure.

fix

Review your `html_to_json.convert()` calls and explicitly set `capture_element_values` or `capture_element_attributes` if precise control over the JSON output's value or attribute inclusion is required.

affects: 1.x.x to 2.0.0

Errors

Common errors & fixes

TypeError: convert() got an unexpected keyword argument 'some_old_param'

Attempting to use parameters that existed in older, potentially non-fhightower/html-to-json versions, or parameters that have been removed/renamed in version 2.0.0.

fix

Refer to the official GitHub README for `fhightower/html-to-json` version 2.0.0 for the correct function signature and available keyword arguments (e.g., `capture_element_values`, `capture_element_attributes`).

KeyError: '_value' or KeyError: '_attributes' in output JSON

Expecting a flattened or different JSON structure, or not accounting for the library's specific output format which uses `_value` for text content and `_attributes` for element attributes.

fix

Understand that the library's JSON output for elements typically includes nested dictionaries with keys like `_value` for text and `_attributes` for HTML attributes. Adjust your JSON parsing logic accordingly. For example, `output_json['head'][0]['title'][0]['_value']` to access the title text.

json.decoder.JSONDecodeError: Expecting value: line X column Y (char Z)

This error occurs when trying to parse the output of `html_to_json.convert` using `json.loads()` and the output is not valid JSON. This typically means the `html_to_json` library encountered highly malformed HTML that it couldn't convert into a well-formed JSON structure, or the conversion function itself returned an error or unexpected string.

fix

Ensure the input HTML is well-formed. Use a HTML validator if the source HTML is external or untrusted. Inspect the raw output of `html_to_json.convert()` before attempting `json.loads()` to identify any intermediate parsing issues.

Upgrade

Version history

3.0.0latest on PyPI · released May 13, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/fhightower/html-to-json ↗

packagehttps://pypi.org/project/html-to-json/ ↗

docshttps://github.com/fhightower/html-to-json ↗

changeloghttps://github.com/fhightower/html-to-json/blob/main/CHANGELOG.md ↗