web2textpy 0.1.0__tar.gz

web2textpy-0.1.0/.claude/settings.local.json

@@ -0,0 +1,19 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv pip:*)",
+      "Bash(python3:*)",
+      "Bash(python:*)",
+      "Bash(/tmp/l3s_final2.py:*)",
+      "Bash(/tmp/l3s_summary.py:*)",
+      "Bash(ls -la /Users/williambrach/Developer/web2textpy/*.py)",
+      "Bash(grep -E \"^libraryDependencies|^import \" /Users/williambrach/Developer/web2textpy/web2text/build.sbt /Users/williambrach/Developer/web2textpy/web2text/src/main/scala/ch/ethz/dalab/web2text/*.scala)",
+      "Bash(echo \"exit: $?\")",
+      "Bash(uv run:*)",
+      "Bash(grep -r \"requests\\\\|urllib\\\\|http\\\\|socket\\\\|fetch\\\\|download\" /Users/williambrach/Developer/web2textpy/*.py)",
+      "Bash(ls:*)",
+      "WebSearch",
+      "WebFetch(domain:discuss.huggingface.co)"
+    ]
+  }
+}

web2textpy-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+web2text/
+scripts/
+# C extensions
+*.so
+.env
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+.DS_Store
+# Sphinx documentation
+docs/_build/
+data/
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

web2textpy-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

web2textpy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 William Brach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

web2textpy-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: web2textpy
+Version: 0.1.0
+Summary: Python reimplementation of the Web2Text pipeline for labeling HTML DOM nodes as content or boilerplate
+Project-URL: Homepage, https://github.com/williambrach/web2textpy
+Project-URL: Repository, https://github.com/williambrach/web2textpy
+Author: William Brach
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Requires-Python: >=3.10
+Requires-Dist: lxml>=6.0.2
+Provides-Extra: cli
+Requires-Dist: datasets>=4.8.4; extra == 'cli'
+Requires-Dist: rouge-score>=0.1.2; extra == 'cli'
+Requires-Dist: sacrebleu>=2.6.0; extra == 'cli'
+Provides-Extra: eval
+Requires-Dist: rouge-score>=0.1.2; extra == 'eval'
+Requires-Dist: sacrebleu>=2.6.0; extra == 'eval'
+Description-Content-Type: text/markdown
+
+# web2textpy
+
+Python reimplementation of the [Web2Text](https://github.com/dalab/web2text) pipeline for labeling HTML DOM nodes as **content** or **boilerplate** using paired `(raw_html, clean_text)` data.
+
+## Installation
+
+```bash
+uv add web2textpy
+```
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+from web2text import run_pipeline
+
+ds = load_dataset("williambrach/html-boilerplate-labeled", split="test")
+row = ds[0]
+
+tree, extracted_text, metrics = run_pipeline(row["html"], row["text"])
+
+print(extracted_text[:200])
+print(metrics)
+```
+
+## Step-by-Step API
+
+Each stage of the pipeline is exposed as a standalone function:
+
+```python
+from web2text import build_cdom, extract_leaves, align, label_nodes, extract_text, evaluate
+
+# 1. Parse HTML into a collapsed DOM tree
+tree = build_cdom(html_string)
+
+# 2. Extract ordered text-bearing leaf nodes
+leaves = extract_leaves(tree)  # [(element, "normalized text"), ...]
+
+# 3. Align leaf texts against ground-truth clean text
+scores = align(leaves, clean_text)  # {leaf_id: 0.0-1.0 match score}
+
+# 4. Label each node as "content" or "boilerplate"
+tree = label_nodes(tree, scores, threshold=0.667)
+
+# 5. Extract text from content-labeled nodes
+result = extract_text(tree)
+
+# 6. Evaluate against ground truth
+metrics = evaluate(result, clean_text)
+# => {'token_f1': 0.99, 'precision': 0.99, 'recall': 0.99, 'rouge1_f': 0.99, 'bleu': 98.5, 'chrf': 98.8}
+```
+
+## How the Matching Algorithm Works
+
+Given raw HTML and its known clean text, the algorithm determines which DOM nodes are content versus boilerplate in six steps:
+
+1. **Simplify the DOM** — strip non-content tags (`<script>`, `<style>`, etc.) and collapse single-child chains into a Collapsed DOM (CDOM) representation
+2. **Collect leaf text** — walk the CDOM, concatenate text from every leaf node into one source string with tracked character offsets
+3. **Find anchors** — identify 10-character substrings that appear exactly once in both the source and clean text, splitting the problem into independent segments
+4. **DP alignment** — for each segment between anchors, run character-level dynamic programming with affine gap penalties to map source characters to clean-text characters
+5. **Score leaves** — map alignment results back to leaf boundaries via stored offsets, giving each leaf a score: `matched_chars / total_chars`
+6. **Label nodes** — leaves scoring above `0.667` are labeled `"content"`, the rest `"boilerplate"`, with labels propagating upward to parents
+
+![Alignment pipeline: extract leaf texts → anchor matching → DP alignment → per-leaf scores](assets/image1.png)
+
+
+## Dataset
+
+Dataset: [williambrach/html-boilerplate-labeled](https://huggingface.co/datasets/williambrach/html-boilerplate-labeled) — ~4k pages from CleanEval, Dragnet, CETD, Readability, and others (3,985 pages total).
+
+| Source             | Train (ROUGE-1 F) | Test (ROUGE-1 F) |
+|--------------------|-------------------|------------------|
+| readability        | 0.993 (92)        | 0.997 (23)       |
+| scrapinghub        | 0.991 (145)       | 0.996 (36)       |
+| cetd               | 0.993 (560)       | 0.987 (140)      |
+| google-trends-2017 | 0.986 (144)       | 0.995 (36)       |
+| cleanportaleval    | 0.985 (57)        | 0.971 (14)       |
+| cleaneval          | 0.985 (590)       | 0.991 (148)      |
+| dragnet            | 0.983 (1,103)     | 0.983 (276)      |
+| l3s-gn1            | 0.920 (497)       | 0.927 (124)      |
+| **Overall**        | **0.976** (3,188)  | **0.978** (797)  |
+
+>Sample counts in parentheses.
+
+## Original Work
+
+- **Paper**: Vogels et al., "Web2Text: Deep Structured Boilerplate Removal" (ECIR 2018) — [arxiv.org/abs/1801.02607](https://arxiv.org/abs/1801.02607)
+- **Original implementation** (Scala): [github.com/dalab/web2text](https://github.com/dalab/web2text)

web2textpy-0.1.0/README.md

@@ -0,0 +1,88 @@
+# web2textpy
+
+Python reimplementation of the [Web2Text](https://github.com/dalab/web2text) pipeline for labeling HTML DOM nodes as **content** or **boilerplate** using paired `(raw_html, clean_text)` data.
+
+## Installation
+
+```bash
+uv add web2textpy
+```
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+from web2text import run_pipeline
+
+ds = load_dataset("williambrach/html-boilerplate-labeled", split="test")
+row = ds[0]
+
+tree, extracted_text, metrics = run_pipeline(row["html"], row["text"])
+
+print(extracted_text[:200])
+print(metrics)
+```
+
+## Step-by-Step API
+
+Each stage of the pipeline is exposed as a standalone function:
+
+```python
+from web2text import build_cdom, extract_leaves, align, label_nodes, extract_text, evaluate
+
+# 1. Parse HTML into a collapsed DOM tree
+tree = build_cdom(html_string)
+
+# 2. Extract ordered text-bearing leaf nodes
+leaves = extract_leaves(tree)  # [(element, "normalized text"), ...]
+
+# 3. Align leaf texts against ground-truth clean text
+scores = align(leaves, clean_text)  # {leaf_id: 0.0-1.0 match score}
+
+# 4. Label each node as "content" or "boilerplate"
+tree = label_nodes(tree, scores, threshold=0.667)
+
+# 5. Extract text from content-labeled nodes
+result = extract_text(tree)
+
+# 6. Evaluate against ground truth
+metrics = evaluate(result, clean_text)
+# => {'token_f1': 0.99, 'precision': 0.99, 'recall': 0.99, 'rouge1_f': 0.99, 'bleu': 98.5, 'chrf': 98.8}
+```
+
+## How the Matching Algorithm Works
+
+Given raw HTML and its known clean text, the algorithm determines which DOM nodes are content versus boilerplate in six steps:
+
+1. **Simplify the DOM** — strip non-content tags (`<script>`, `<style>`, etc.) and collapse single-child chains into a Collapsed DOM (CDOM) representation
+2. **Collect leaf text** — walk the CDOM, concatenate text from every leaf node into one source string with tracked character offsets
+3. **Find anchors** — identify 10-character substrings that appear exactly once in both the source and clean text, splitting the problem into independent segments
+4. **DP alignment** — for each segment between anchors, run character-level dynamic programming with affine gap penalties to map source characters to clean-text characters
+5. **Score leaves** — map alignment results back to leaf boundaries via stored offsets, giving each leaf a score: `matched_chars / total_chars`
+6. **Label nodes** — leaves scoring above `0.667` are labeled `"content"`, the rest `"boilerplate"`, with labels propagating upward to parents
+
+![Alignment pipeline: extract leaf texts → anchor matching → DP alignment → per-leaf scores](assets/image1.png)
+
+
+## Dataset
+
+Dataset: [williambrach/html-boilerplate-labeled](https://huggingface.co/datasets/williambrach/html-boilerplate-labeled) — ~4k pages from CleanEval, Dragnet, CETD, Readability, and others (3,985 pages total).
+
+| Source             | Train (ROUGE-1 F) | Test (ROUGE-1 F) |
+|--------------------|-------------------|------------------|
+| readability        | 0.993 (92)        | 0.997 (23)       |
+| scrapinghub        | 0.991 (145)       | 0.996 (36)       |
+| cetd               | 0.993 (560)       | 0.987 (140)      |
+| google-trends-2017 | 0.986 (144)       | 0.995 (36)       |
+| cleanportaleval    | 0.985 (57)        | 0.971 (14)       |
+| cleaneval          | 0.985 (590)       | 0.991 (148)      |
+| dragnet            | 0.983 (1,103)     | 0.983 (276)      |
+| l3s-gn1            | 0.920 (497)       | 0.927 (124)      |
+| **Overall**        | **0.976** (3,188)  | **0.978** (797)  |
+
+>Sample counts in parentheses.
+
+## Original Work
+
+- **Paper**: Vogels et al., "Web2Text: Deep Structured Boilerplate Removal" (ECIR 2018) — [arxiv.org/abs/1801.02607](https://arxiv.org/abs/1801.02607)
+- **Original implementation** (Scala): [github.com/dalab/web2text](https://github.com/dalab/web2text)

web2textpy-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "web2textpy"
+version = "0.1.0"
+description = "Python reimplementation of the Web2Text pipeline for labeling HTML DOM nodes as content or boilerplate"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "William Brach" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Text Processing :: Markup :: HTML",
+]
+dependencies = [
+    "lxml>=6.0.2",
+]
+
+[project.optional-dependencies]
+eval = [
+    "rouge-score>=0.1.2",
+    "sacrebleu>=2.6.0",
+]
+cli = [
+    "datasets>=4.8.4",
+    "rouge-score>=0.1.2",
+    "sacrebleu>=2.6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/williambrach/web2textpy"
+Repository = "https://github.com/williambrach/web2textpy"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["web2text.py"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["assets/", "evaluate.py", "push_to_hf.py"]