html-to-markdown 1.2.0__tar.gz → 1.3.0__tar.gz

{html_to_markdown-1.2.0 → html_to_markdown-1.3.0}/LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
 Copyright 2012-2018 Matthew Tretter
-Copyright 2024 Na'aman Hirschfeld
+Copyright 2024-2025 Na'aman Hirschfeld
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

html_to_markdown-1.3.0/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: html-to-markdown
+Version: 1.3.0
+Summary: Convert HTML to markdown
+Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
+License: MIT
+Project-URL: homepage, https://github.com/Goldziher/html-to-markdown
+Keywords: converter,html,markdown,text-extraction,text-processing
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.12.3
+Dynamic: license-file
+
+# html-to-markdown
+
+A modern, fully typed Python library for converting HTML to Markdown. This library is a completely rewritten fork
+of [markdownify](https://pypi.org/project/markdownify/) with a modernized codebase, strict type safety and support for
+Python 3.9+.
+
+## Features
+
+- Full type safety with strict MyPy adherence
+- Functional API design
+- Extensive test coverage
+- Configurable conversion options
+- CLI tool for easy conversions
+- Support for pre-configured BeautifulSoup instances
+- Strict semver versioning
+
+## Installation
+
+```shell
+pip install html-to-markdown
+```
+
+## Quick Start
+
+Convert HTML to Markdown with a single function call:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = """
+<article>
+    <h1>Welcome</h1>
+    <p>This is a <strong>sample</strong> with a <a href="https://example.com">link</a>.</p>
+    <ul>
+        <li>Item 1</li>
+        <li>Item 2</li>
+    </ul>
+</article>
+"""
+
+markdown = convert_to_markdown(html)
+print(markdown)
+```
+
+Output:
+
+```markdown
+# Welcome
+
+This is a **sample** with a [link](https://example.com).
+
+* Item 1
+* Item 2
+```
+
+### Working with BeautifulSoup
+
+If you need more control over HTML parsing, you can pass a pre-configured BeautifulSoup instance:
+
+```python
+from bs4 import BeautifulSoup
+from html_to_markdown import convert_to_markdown
+
+# Configure BeautifulSoup with your preferred parser
+soup = BeautifulSoup(html, "lxml")  # Note: lxml requires additional installation
+markdown = convert_to_markdown(soup)
+```
+
+## Advanced Usage
+
+### Customizing Conversion Options
+
+The library offers extensive customization through various options:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = "<div>Your content here...</div>"
+markdown = convert_to_markdown(
+    html,
+    heading_style="atx",  # Use # style headers
+    strong_em_symbol="*",  # Use * for bold/italic
+    bullets="*+-",  # Define bullet point characters
+    wrap=True,  # Enable text wrapping
+    wrap_width=100,  # Set wrap width
+    escape_asterisks=True,  # Escape * characters
+    code_language="python",  # Default code block language
+)
+```
+
+### Custom Converters
+
+You can provide your own conversion functions for specific HTML tags:
+
+```python
+from bs4.element import Tag
+from html_to_markdown import convert_to_markdown
+
+# Define a custom converter for the <b> tag
+def custom_bold_converter(*, tag: Tag, text: str, **kwargs) -> str:
+    return f"IMPORTANT: {text}"
+
+html = "<p>This is a <b>bold statement</b>.</p>"
+markdown = convert_to_markdown(html, custom_converters={"b": custom_bold_converter})
+print(markdown)
+# Output: This is a IMPORTANT: bold statement.
+```
+
+Custom converters take precedence over the built-in converters and can be used alongside other configuration options.
+
+### Configuration Options
+
+| Option               | Type | Default        | Description                                            |
+| -------------------- | ---- | -------------- | ------------------------------------------------------ |
+| `autolinks`          | bool | `True`         | Auto-convert URLs to Markdown links                    |
+| `bullets`            | str  | `'*+-'`        | Characters to use for bullet points                    |
+| `code_language`      | str  | `''`           | Default language for code blocks                       |
+| `heading_style`      | str  | `'underlined'` | Header style (`'underlined'`, `'atx'`, `'atx_closed'`) |
+| `escape_asterisks`   | bool | `True`         | Escape * characters                                    |
+| `escape_underscores` | bool | `True`         | Escape _ characters                                    |
+| `wrap`               | bool | `False`        | Enable text wrapping                                   |
+| `wrap_width`         | int  | `80`           | Text wrap width                                        |
+
+For a complete list of options, see the [Configuration](#configuration) section below.
+
+## CLI Usage
+
+Convert HTML files directly from the command line:
+
+```shell
+# Convert a file
+html_to_markdown input.html > output.md
+
+# Process stdin
+cat input.html | html_to_markdown > output.md
+
+# Use custom options
+html_to_markdown --heading-style atx --wrap --wrap-width 100 input.html > output.md
+```
+
+View all available options:
+
+```shell
+html_to_markdown --help
+```
+
+## Migration from Markdownify
+
+For existing projects using Markdownify, a compatibility layer is provided:
+
+```python
+# Old code
+from markdownify import markdownify as md
+
+# New code - works the same way
+from html_to_markdown import markdownify as md
+```
+
+The `markdownify` function is an alias for `convert_to_markdown` and provides identical functionality.
+
+## Configuration
+
+Full list of configuration options:
+
+- `autolinks`: Convert valid URLs to Markdown links automatically
+- `bullets`: Characters to use for bullet points in lists
+- `code_language`: Default language for fenced code blocks
+- `code_language_callback`: Function to determine code block language
+- `convert`: List of HTML tags to convert (None = all supported tags)
+- `default_title`: Use default titles for elements like links
+- `escape_asterisks`: Escape * characters
+- `escape_misc`: Escape miscellaneous Markdown characters
+- `escape_underscores`: Escape _ characters
+- `heading_style`: Header style (underlined/atx/atx_closed)
+- `keep_inline_images_in`: Tags where inline images should be kept
+- `newline_style`: Style for handling newlines (spaces/backslash)
+- `strip`: Tags to remove from output
+- `strong_em_symbol`: Symbol for strong/emphasized text (\* or \_)
+- `sub_symbol`: Symbol for subscript text
+- `sup_symbol`: Symbol for superscript text
+- `wrap`: Enable text wrapping
+- `wrap_width`: Width for text wrapping
+- `convert_as_inline`: Treat content as inline elements
+- `custom_converters`: A mapping of HTML tag names to custom converter functions
+
+## Contribution
+
+This library is open to contribution. Feel free to open issues or submit PRs. Its better to discuss issues before
+submitting PRs to avoid disappointment.
+
+### Local Development
+
+1. Clone the repo
+
+1. Install the system dependencies
+
+1. Install the full dependencies with `uv sync`
+
+1. Install the pre-commit hooks with:
+
+    ```shell
+    pre-commit install && pre-commit install --hook-type commit-msg
+    ```
+
+1. Make your changes and submit a PR
+
+## License
+
+This library uses the MIT license.
+
+## Acknowledgments
+
+Special thanks to the original [markdownify](https://pypi.org/project/markdownify/) project creators and contributors.

html_to_markdown-1.3.0/README.md

@@ -0,0 +1,213 @@
+# html-to-markdown
+
+A modern, fully typed Python library for converting HTML to Markdown. This library is a completely rewritten fork
+of [markdownify](https://pypi.org/project/markdownify/) with a modernized codebase, strict type safety and support for
+Python 3.9+.
+
+## Features
+
+- Full type safety with strict MyPy adherence
+- Functional API design
+- Extensive test coverage
+- Configurable conversion options
+- CLI tool for easy conversions
+- Support for pre-configured BeautifulSoup instances
+- Strict semver versioning
+
+## Installation
+
+```shell
+pip install html-to-markdown
+```
+
+## Quick Start
+
+Convert HTML to Markdown with a single function call:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = """
+<article>
+    <h1>Welcome</h1>
+    <p>This is a <strong>sample</strong> with a <a href="https://example.com">link</a>.</p>
+    <ul>
+        <li>Item 1</li>
+        <li>Item 2</li>
+    </ul>
+</article>
+"""
+
+markdown = convert_to_markdown(html)
+print(markdown)
+```
+
+Output:
+
+```markdown
+# Welcome
+
+This is a **sample** with a [link](https://example.com).
+
+* Item 1
+* Item 2
+```
+
+### Working with BeautifulSoup
+
+If you need more control over HTML parsing, you can pass a pre-configured BeautifulSoup instance:
+
+```python
+from bs4 import BeautifulSoup
+from html_to_markdown import convert_to_markdown
+
+# Configure BeautifulSoup with your preferred parser
+soup = BeautifulSoup(html, "lxml")  # Note: lxml requires additional installation
+markdown = convert_to_markdown(soup)
+```
+
+## Advanced Usage
+
+### Customizing Conversion Options
+
+The library offers extensive customization through various options:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = "<div>Your content here...</div>"
+markdown = convert_to_markdown(
+    html,
+    heading_style="atx",  # Use # style headers
+    strong_em_symbol="*",  # Use * for bold/italic
+    bullets="*+-",  # Define bullet point characters
+    wrap=True,  # Enable text wrapping
+    wrap_width=100,  # Set wrap width
+    escape_asterisks=True,  # Escape * characters
+    code_language="python",  # Default code block language
+)
+```
+
+### Custom Converters
+
+You can provide your own conversion functions for specific HTML tags:
+
+```python
+from bs4.element import Tag
+from html_to_markdown import convert_to_markdown
+
+# Define a custom converter for the <b> tag
+def custom_bold_converter(*, tag: Tag, text: str, **kwargs) -> str:
+    return f"IMPORTANT: {text}"
+
+html = "<p>This is a <b>bold statement</b>.</p>"
+markdown = convert_to_markdown(html, custom_converters={"b": custom_bold_converter})
+print(markdown)
+# Output: This is a IMPORTANT: bold statement.
+```
+
+Custom converters take precedence over the built-in converters and can be used alongside other configuration options.
+
+### Configuration Options
+
+| Option               | Type | Default        | Description                                            |
+| -------------------- | ---- | -------------- | ------------------------------------------------------ |
+| `autolinks`          | bool | `True`         | Auto-convert URLs to Markdown links                    |
+| `bullets`            | str  | `'*+-'`        | Characters to use for bullet points                    |
+| `code_language`      | str  | `''`           | Default language for code blocks                       |
+| `heading_style`      | str  | `'underlined'` | Header style (`'underlined'`, `'atx'`, `'atx_closed'`) |
+| `escape_asterisks`   | bool | `True`         | Escape * characters                                    |
+| `escape_underscores` | bool | `True`         | Escape _ characters                                    |
+| `wrap`               | bool | `False`        | Enable text wrapping                                   |
+| `wrap_width`         | int  | `80`           | Text wrap width                                        |
+
+For a complete list of options, see the [Configuration](#configuration) section below.
+
+## CLI Usage
+
+Convert HTML files directly from the command line:
+
+```shell
+# Convert a file
+html_to_markdown input.html > output.md
+
+# Process stdin
+cat input.html | html_to_markdown > output.md
+
+# Use custom options
+html_to_markdown --heading-style atx --wrap --wrap-width 100 input.html > output.md
+```
+
+View all available options:
+
+```shell
+html_to_markdown --help
+```
+
+## Migration from Markdownify
+
+For existing projects using Markdownify, a compatibility layer is provided:
+
+```python
+# Old code
+from markdownify import markdownify as md
+
+# New code - works the same way
+from html_to_markdown import markdownify as md
+```
+
+The `markdownify` function is an alias for `convert_to_markdown` and provides identical functionality.
+
+## Configuration
+
+Full list of configuration options:
+
+- `autolinks`: Convert valid URLs to Markdown links automatically
+- `bullets`: Characters to use for bullet points in lists
+- `code_language`: Default language for fenced code blocks
+- `code_language_callback`: Function to determine code block language
+- `convert`: List of HTML tags to convert (None = all supported tags)
+- `default_title`: Use default titles for elements like links
+- `escape_asterisks`: Escape * characters
+- `escape_misc`: Escape miscellaneous Markdown characters
+- `escape_underscores`: Escape _ characters
+- `heading_style`: Header style (underlined/atx/atx_closed)
+- `keep_inline_images_in`: Tags where inline images should be kept
+- `newline_style`: Style for handling newlines (spaces/backslash)
+- `strip`: Tags to remove from output
+- `strong_em_symbol`: Symbol for strong/emphasized text (\* or \_)
+- `sub_symbol`: Symbol for subscript text
+- `sup_symbol`: Symbol for superscript text
+- `wrap`: Enable text wrapping
+- `wrap_width`: Width for text wrapping
+- `convert_as_inline`: Treat content as inline elements
+- `custom_converters`: A mapping of HTML tag names to custom converter functions
+
+## Contribution
+
+This library is open to contribution. Feel free to open issues or submit PRs. Its better to discuss issues before
+submitting PRs to avoid disappointment.
+
+### Local Development
+
+1. Clone the repo
+
+1. Install the system dependencies
+
+1. Install the full dependencies with `uv sync`
+
+1. Install the pre-commit hooks with:
+
+    ```shell
+    pre-commit install && pre-commit install --hook-type commit-msg
+    ```
+
+1. Make your changes and submit a PR
+
+## License
+
+This library uses the MIT license.
+
+## Acknowledgments
+
+Special thanks to the original [markdownify](https://pypi.org/project/markdownify/) project creators and contributors.

html_to_markdown-1.3.0/html_to_markdown/__init__.py

@@ -0,0 +1,5 @@
+from html_to_markdown.processing import convert_to_markdown
+
+markdownify = convert_to_markdown
+
+__all__ = ["convert_to_markdown", "markdownify"]

{html_to_markdown-1.2.0 → html_to_markdown-1.3.0}/html_to_markdown/converters.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from collections.abc import Iterable, Mapping
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
 from functools import partial
 from inspect import getfullargspec
 from textwrap import fill
@@ -55,7 +58,8 @@ SupportedElements = Literal[
     "kbd",
 ]
 
-ConvertersMap = Mapping[SupportedElements, Callable[[str, Tag], str]]
+Converter = Callable[[str, Tag], str]
+ConvertersMap = dict[SupportedElements, Converter]
 
 T = TypeVar("T")
 
@@ -85,7 +89,7 @@ def _create_inline_converter(markup_prefix: str) -> Callable[[Tag, str], str]:
 
         return f"{prefix}{markup_prefix}{text}{markup_suffix}{suffix}"
 
-    return cast(Callable[[Tag, str], str], implementation)
+    return cast("Callable[[Tag, str], str]", implementation)
 
 
 def _get_colspan(tag: Tag) -> int:
@@ -187,7 +191,7 @@ def _convert_li(*, tag: Tag, text: str, bullets: str) -> str:
     parent = tag.parent
     if parent is not None and parent.name == "ol":
         start = (
-            int(cast(str, parent["start"]))
+            int(cast("str", parent["start"]))
             if isinstance(parent.get("start"), str) and str(parent.get("start")).isnumeric()
             else 1
         )
@@ -263,7 +267,6 @@ def _convert_tr(*, tag: Tag, text: str) -> str:
     overline = ""
     underline = ""
     if is_headrow and not tag.previous_sibling:
-        # first row and is headline: print headline underline
         full_colspan = 0
         for cell in cells:
             if "colspan" in cell.attrs and cell["colspan"].isdigit():
@@ -272,12 +275,8 @@ def _convert_tr(*, tag: Tag, text: str) -> str:
                 full_colspan += 1
         underline += "| " + " | ".join(["---"] * full_colspan) + " |" + "\n"
     elif not tag.previous_sibling and (
-        parent_name == "table" or (parent_name == "tbody" and not cast(Tag, tag.parent).previous_sibling)
+        parent_name == "table" or (parent_name == "tbody" and not cast("Tag", tag.parent).previous_sibling)
     ):
-        # first row, not headline, and:
-        # - the parent is table or
-        # - the parent is tbody at the beginning of a table.
-        # print empty headline above this row
         overline += "| " + " | ".join([""] * len(cells)) + " |" + "\n"
         overline += "| " + " | ".join(["---"] * len(cells)) + " |" + "\n"
     return overline + "|" + text + "\n" + underline
@@ -334,7 +333,7 @@ def create_converters_map(
                 return func(**kwargs)
             return func(text)
 
-        return cast(Callable[[str, Tag], T], _inner)
+        return cast("Callable[[str, Tag], T]", _inner)
 
     return {
         "a": _wrapper(partial(_convert_a, autolinks=autolinks, default_title=default_title)),

{html_to_markdown-1.2.0 → html_to_markdown-1.3.0}/html_to_markdown/processing.py

@@ -1,5 +1,9 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
 from itertools import chain
 from typing import TYPE_CHECKING, Any, Callable, Literal, cast
 
@@ -12,7 +16,7 @@ from html_to_markdown.constants import (
     html_heading_re,
     whitespace_re,
 )
-from html_to_markdown.converters import ConvertersMap, create_converters_map
+from html_to_markdown.converters import Converter, ConvertersMap, SupportedElements, create_converters_map
 from html_to_markdown.utils import escape
 
 if TYPE_CHECKING:
@@ -87,7 +91,9 @@ def _process_tag(
     strip: set[str] | None,
 ) -> str:
     should_convert_tag = _should_convert_tag(tag_name=tag.name, strip=strip, convert=convert)
-    tag_name: SupportedTag | None = cast(SupportedTag, tag.name.lower()) if tag.name.lower() in converters_map else None
+    tag_name: SupportedTag | None = (
+        cast("SupportedTag", tag.name.lower()) if tag.name.lower() in converters_map else None
+    )
     text = ""
 
     is_heading = html_heading_re.match(tag.name) is not None
@@ -142,11 +148,9 @@ def _process_text(
 ) -> str:
     text = str(el) or ""
 
-    # normalize whitespace if we're not inside a preformatted element
     if not el.find_parent("pre"):
         text = whitespace_re.sub(" ", text)
 
-    # escape special characters if we're not inside a preformatted or code element
     if not el.find_parent(["pre", "code", "kbd", "samp"]):
         text = escape(
             text=text,
@@ -155,9 +159,6 @@ def _process_text(
             escape_underscores=escape_underscores,
         )
 
-    # remove trailing whitespaces if any of the following condition is true:
-    # - current text node is the last node in li
-    # - current text node is followed by an embedded list
     if (
         el.parent
         and el.parent.name == "li"
@@ -192,6 +193,8 @@ def convert_to_markdown(
     code_language: str = "",
     code_language_callback: Callable[[Any], str] | None = None,
     convert: str | Iterable[str] | None = None,
+    convert_as_inline: bool = False,
+    custom_converters: Mapping[SupportedElements, Converter] | None = None,
     default_title: bool = False,
     escape_asterisks: bool = True,
     escape_misc: bool = True,
@@ -205,7 +208,6 @@ def convert_to_markdown(
     sup_symbol: str = "",
     wrap: bool = False,
     wrap_width: int = 80,
-    convert_as_inline: bool = False,
 ) -> str:
     """Convert HTML to Markdown.
 
@@ -216,6 +218,8 @@ def convert_to_markdown(
         code_language: Default language identifier for fenced code blocks. Defaults to an empty string.
         code_language_callback: Function to dynamically determine the language for code blocks.
         convert: A list of tag names to convert to Markdown. If None, all supported tags are converted.
+        convert_as_inline: Treat the content as inline elements (no block elements like paragraphs). Defaults to False.
+        custom_converters: A mapping of custom converters for specific HTML tags. Defaults to None.
         default_title: Use the default title when converting certain elements (e.g., links). Defaults to False.
         escape_asterisks: Escape asterisks (*) to prevent unintended Markdown formatting. Defaults to True.
         escape_misc: Escape miscellaneous characters to prevent conflicts in Markdown. Defaults to True.
@@ -229,7 +233,6 @@ def convert_to_markdown(
         sup_symbol: Custom symbol for superscript text. Defaults to an empty string.
         wrap: Wrap text to the specified width. Defaults to False.
         wrap_width: The number of characters at which to wrap text. Defaults to 80.
-        convert_as_inline: Treat the content as inline elements (no block elements like paragraphs). Defaults to False.
 
     Raises:
         ValueError: If both 'strip' and 'convert' are specified, or when the input HTML is empty.
@@ -263,6 +266,8 @@ def convert_to_markdown(
         wrap=wrap,
         wrap_width=wrap_width,
     )
+    if custom_converters:
+        converters_map.update(cast("ConvertersMap", custom_converters))
 
     return _process_tag(
         source,

html_to_markdown-1.3.0/html_to_markdown.egg-info/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: html-to-markdown
+Version: 1.3.0
+Summary: Convert HTML to markdown
+Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
+License: MIT
+Project-URL: homepage, https://github.com/Goldziher/html-to-markdown
+Keywords: converter,html,markdown,text-extraction,text-processing
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.12.3
+Dynamic: license-file
+
+# html-to-markdown
+
+A modern, fully typed Python library for converting HTML to Markdown. This library is a completely rewritten fork
+of [markdownify](https://pypi.org/project/markdownify/) with a modernized codebase, strict type safety and support for
+Python 3.9+.
+
+## Features
+
+- Full type safety with strict MyPy adherence
+- Functional API design
+- Extensive test coverage
+- Configurable conversion options
+- CLI tool for easy conversions
+- Support for pre-configured BeautifulSoup instances
+- Strict semver versioning
+
+## Installation
+
+```shell
+pip install html-to-markdown
+```
+
+## Quick Start
+
+Convert HTML to Markdown with a single function call:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = """
+<article>
+    <h1>Welcome</h1>
+    <p>This is a <strong>sample</strong> with a <a href="https://example.com">link</a>.</p>
+    <ul>
+        <li>Item 1</li>
+        <li>Item 2</li>
+    </ul>
+</article>
+"""
+
+markdown = convert_to_markdown(html)
+print(markdown)
+```
+
+Output:
+
+```markdown
+# Welcome
+
+This is a **sample** with a [link](https://example.com).
+
+* Item 1
+* Item 2
+```
+
+### Working with BeautifulSoup
+
+If you need more control over HTML parsing, you can pass a pre-configured BeautifulSoup instance:
+
+```python
+from bs4 import BeautifulSoup
+from html_to_markdown import convert_to_markdown
+
+# Configure BeautifulSoup with your preferred parser
+soup = BeautifulSoup(html, "lxml")  # Note: lxml requires additional installation
+markdown = convert_to_markdown(soup)
+```
+
+## Advanced Usage
+
+### Customizing Conversion Options
+
+The library offers extensive customization through various options:
+
+```python
+from html_to_markdown import convert_to_markdown
+
+html = "<div>Your content here...</div>"
+markdown = convert_to_markdown(
+    html,
+    heading_style="atx",  # Use # style headers
+    strong_em_symbol="*",  # Use * for bold/italic
+    bullets="*+-",  # Define bullet point characters
+    wrap=True,  # Enable text wrapping
+    wrap_width=100,  # Set wrap width
+    escape_asterisks=True,  # Escape * characters
+    code_language="python",  # Default code block language
+)
+```
+
+### Custom Converters
+
+You can provide your own conversion functions for specific HTML tags:
+
+```python
+from bs4.element import Tag
+from html_to_markdown import convert_to_markdown
+
+# Define a custom converter for the <b> tag
+def custom_bold_converter(*, tag: Tag, text: str, **kwargs) -> str:
+    return f"IMPORTANT: {text}"
+
+html = "<p>This is a <b>bold statement</b>.</p>"
+markdown = convert_to_markdown(html, custom_converters={"b": custom_bold_converter})
+print(markdown)
+# Output: This is a IMPORTANT: bold statement.
+```
+
+Custom converters take precedence over the built-in converters and can be used alongside other configuration options.
+
+### Configuration Options
+
+| Option               | Type | Default        | Description                                            |
+| -------------------- | ---- | -------------- | ------------------------------------------------------ |
+| `autolinks`          | bool | `True`         | Auto-convert URLs to Markdown links                    |
+| `bullets`            | str  | `'*+-'`        | Characters to use for bullet points                    |
+| `code_language`      | str  | `''`           | Default language for code blocks                       |
+| `heading_style`      | str  | `'underlined'` | Header style (`'underlined'`, `'atx'`, `'atx_closed'`) |
+| `escape_asterisks`   | bool | `True`         | Escape * characters                                    |
+| `escape_underscores` | bool | `True`         | Escape _ characters                                    |
+| `wrap`               | bool | `False`        | Enable text wrapping                                   |
+| `wrap_width`         | int  | `80`           | Text wrap width                                        |
+
+For a complete list of options, see the [Configuration](#configuration) section below.
+
+## CLI Usage
+
+Convert HTML files directly from the command line:
+
+```shell
+# Convert a file
+html_to_markdown input.html > output.md
+
+# Process stdin
+cat input.html | html_to_markdown > output.md
+
+# Use custom options
+html_to_markdown --heading-style atx --wrap --wrap-width 100 input.html > output.md
+```
+
+View all available options:
+
+```shell
+html_to_markdown --help
+```
+
+## Migration from Markdownify
+
+For existing projects using Markdownify, a compatibility layer is provided:
+
+```python
+# Old code
+from markdownify import markdownify as md
+
+# New code - works the same way
+from html_to_markdown import markdownify as md
+```
+
+The `markdownify` function is an alias for `convert_to_markdown` and provides identical functionality.
+
+## Configuration
+
+Full list of configuration options:
+
+- `autolinks`: Convert valid URLs to Markdown links automatically
+- `bullets`: Characters to use for bullet points in lists
+- `code_language`: Default language for fenced code blocks
+- `code_language_callback`: Function to determine code block language
+- `convert`: List of HTML tags to convert (None = all supported tags)
+- `default_title`: Use default titles for elements like links
+- `escape_asterisks`: Escape * characters
+- `escape_misc`: Escape miscellaneous Markdown characters
+- `escape_underscores`: Escape _ characters
+- `heading_style`: Header style (underlined/atx/atx_closed)
+- `keep_inline_images_in`: Tags where inline images should be kept
+- `newline_style`: Style for handling newlines (spaces/backslash)
+- `strip`: Tags to remove from output
+- `strong_em_symbol`: Symbol for strong/emphasized text (\* or \_)
+- `sub_symbol`: Symbol for subscript text
+- `sup_symbol`: Symbol for superscript text
+- `wrap`: Enable text wrapping
+- `wrap_width`: Width for text wrapping
+- `convert_as_inline`: Treat content as inline elements
+- `custom_converters`: A mapping of HTML tag names to custom converter functions
+
+## Contribution
+
+This library is open to contribution. Feel free to open issues or submit PRs. Its better to discuss issues before
+submitting PRs to avoid disappointment.
+
+### Local Development
+
+1. Clone the repo
+
+1. Install the system dependencies
+
+1. Install the full dependencies with `uv sync`
+
+1. Install the pre-commit hooks with:
+
+    ```shell
+    pre-commit install && pre-commit install --hook-type commit-msg
+    ```
+
+1. Make your changes and submit a PR
+
+## License
+
+This library uses the MIT license.
+
+## Acknowledgments
+
+Special thanks to the original [markdownify](https://pypi.org/project/markdownify/) project creators and contributors.

html_to_markdown-1.3.0/html_to_markdown.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+html_to_markdown/__init__.py
+html_to_markdown/__main__.py
+html_to_markdown/cli.py
+html_to_markdown/constants.py
+html_to_markdown/converters.py
+html_to_markdown/processing.py
+html_to_markdown/py.typed
+html_to_markdown/utils.py
+html_to_markdown.egg-info/PKG-INFO
+html_to_markdown.egg-info/SOURCES.txt
+html_to_markdown.egg-info/dependency_links.txt
+html_to_markdown.egg-info/requires.txt
+html_to_markdown.egg-info/top_level.txt

html_to_markdown-1.3.0/html_to_markdown.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

html_to_markdown-1.3.0/html_to_markdown.egg-info/requires.txt

@@ -0,0 +1 @@
+beautifulsoup4>=4.12.3

html_to_markdown-1.3.0/html_to_markdown.egg-info/top_level.txt

@@ -0,0 +1 @@
+html_to_markdown

{html_to_markdown-1.2.0 → html_to_markdown-1.3.0}/pyproject.toml

@@ -1,15 +1,14 @@
 [build-system]
-build-backend = "hatchling.build"
+build-backend = "setuptools.build_meta"
 
-requires = [ "hatchling" ]
+requires = [ "setuptools>=78.1" ]
 
 [project]
 name = "html-to-markdown"
-version = "1.2.0"
+version = "1.3.0"
 description = "Convert HTML to markdown"
 readme = "README.md"
 keywords = [ "converter", "html", "markdown", "text-extraction", "text-processing" ]
-
 license = { text = "MIT" }
 authors = [ { name = "Na'aman Hirschfeld", email = "nhirschfeld@gmail.com" } ]
 requires-python = ">=3.9"
@@ -30,30 +29,36 @@ classifiers = [
   "Topic :: Utilities",
   "Typing :: Typed",
 ]
+
 dependencies = [
   "beautifulsoup4>=4.12.3",
 ]
 
+urls.homepage = "https://github.com/Goldziher/html-to-markdown"
+
 [dependency-groups]
 dev = [
   "covdefaults>=2.3",
   "mypy>=1.14.1",
   "pre-commit>=4.1",
   "pytest>=8.3.4",
-  "pytest-cov>=6",
+  "pytest-cov>=6.1",
   "pytest-mock>=3.14",
   "ruff>=0.9.3",
   "types-beautifulsoup4>=4.12.0.20241020",
+  "uv-bump",
 ]
 
+[tool.setuptools.packages.find]
+include = [ "html_to_markdown" ]
+
+[tool.setuptools.package-data]
+html_to_markdown = [ "py.typed" ]
+
 [tool.hatch.build]
 skip-excluded-dirs = true
 
-[tool.hatch.build.targets.sdist]
-only-include = [ "html_to_markdown" ]
-
-[tool.hatch.build.targets.wheel]
-only-include = [ "html_to_markdown" ]
+scripts.html_to_markdown = "html_to_markdown.__main__:cli"
 
 [tool.ruff]
 target-version = "py39"
@@ -111,3 +116,6 @@ disallow_untyped_decorators = false
 
 [tool.uv]
 default-groups = [ "dev" ]
+
+[tool.uv.sources]
+uv-bump = { git = "https://github.com/Goldziher/uv-bump" }

html_to_markdown-1.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

html_to_markdown-1.2.0/.gitignore

@@ -1,21 +0,0 @@
-*$py.class
-*.iml
-*.log
-*.py[cod]
-.coverage
-.env
-.idea/
-.mypy_cache/
-.pdm-build/
-.pdm-python
-.pdm.toml
-.pytest_cache/
-.python-version
-.ruff_cache/
-.tox/
-.venv/
-.vscode/
-__pycache__/
-__pypackages__/
-coverage.xml
-dist/

html_to_markdown-1.2.0/PKG-INFO

@@ -1,102 +0,0 @@
-Metadata-Version: 2.4
-Name: html-to-markdown
-Version: 1.2.0
-Summary: Convert HTML to markdown
-Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
-License: MIT
-License-File: LICENSE
-Keywords: converter,html,markdown,text-extraction,text-processing
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-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
-Classifier: Topic :: Text Processing :: Markup
-Classifier: Topic :: Text Processing :: Markup :: HTML
-Classifier: Topic :: Text Processing :: Markup :: Markdown
-Classifier: Topic :: Utilities
-Classifier: Typing :: Typed
-Requires-Python: >=3.9
-Requires-Dist: beautifulsoup4>=4.12.3
-Description-Content-Type: text/markdown
-
-# html_to_markdown
-
-This library is a refactored and modernized fork of [markdownify](https://pypi.org/project/markdownify/), supporting
-Python 3.9 and above.
-
-### Differences with the Markdownify
-
-- The refactored codebase uses a strict functional approach - no classes are involved.
-- There is full typing with strict MyPy strict adherence and a py.typed file included.
-- The `convert_to_markdown` function allows passing a pre-configured instance of `BeautifulSoup` instead of html.
-- This library releases follows standard semver. Its version v1.0.0 was branched from markdownify's v0.13.1, at which
-  point versioning is no longer aligned.
-
-## Installation
-
-```shell
-pip install html_to_markdown
-```
-
-## Usage
-
-Convert an string HTML to Markdown:
-
-```python
-from html_to_markdown import convert_to_markdown
-
-convert_to_markdown('<b>Yay</b> <a href="http://github.com">GitHub</a>')  # > '**Yay** [GitHub](http://github.com)'
-```
-
-Or pass a pre-configured instance of `BeautifulSoup`:
-
-```python
-from bs4 import BeautifulSoup
-from html_to_markdown import convert_to_markdown
-
-soup = BeautifulSoup('<b>Yay</b> <a href="http://github.com">GitHub</a>', 'lxml')  # lxml requires an extra dependency.
-
-convert_to_markdown(soup)  # > '**Yay** [GitHub](http://github.com)'
-```
-
-### Options
-
-The `convert_to_markdown` function accepts the following kwargs:
-
-- autolinks (bool): Automatically convert valid URLs into Markdown links. Defaults to True.
-- bullets (str): A string of characters to use for bullet points in lists. Defaults to '\*+-'.
-- code_language (str): Default language identifier for fenced code blocks. Defaults to an empty string.
-- code_language_callback (Callable[[Any], str] | None): Function to dynamically determine the language for code blocks.
-- convert (Iterable[str] | None): A list of tag names to convert to Markdown. If None, all supported tags are converted.
-- default_title (bool): Use the default title when converting certain elements (e.g., links). Defaults to False.
-- escape_asterisks (bool): Escape asterisks (\*) to prevent unintended Markdown formatting. Defaults to True.
-- escape_misc (bool): Escape miscellaneous characters to prevent conflicts in Markdown. Defaults to True.
-- escape*underscores (bool): Escape underscores (*) to prevent unintended italic formatting. Defaults to True.
-- heading_style (Literal["underlined", "atx", "atx_closed"]): The style to use for Markdown headings. Defaults to "
-  underlined".
-- keep_inline_images_in (Iterable[str] | None): Tags in which inline images should be preserved. Defaults to None.
-- newline_style (Literal["spaces", "backslash"]): Style for handling newlines in text content. Defaults to "spaces".
-- strip (Iterable[str] | None): Tags to strip from the output. Defaults to None.
-- strong*em_symbol (Literal["\*", "*"]): Symbol to use for strong/emphasized text. Defaults to "\*".
-- sub_symbol (str): Custom symbol for subscript text. Defaults to an empty string.
-- sup_symbol (str): Custom symbol for superscript text. Defaults to an empty string.
-- wrap (bool): Wrap text to the specified width. Defaults to False.
-- wrap_width (int): The number of characters at which to wrap text. Defaults to 80.
-- convert_as_inline (bool): Treat the content as inline elements (no block elements like paragraphs). Defaults to False.
-
-## CLI
-
-For compatibility with the original markdownify, a CLI is provided. Use `html_to_markdown example.html > example.md` or
-pipe input from stdin:
-
-```shell
-cat example.html | html_to_markdown > example.md
-```
-
-Use `html_to_markdown -h` to see all available options. They are the same as listed above and take the same arguments.

html_to_markdown-1.2.0/README.md

@@ -1,75 +0,0 @@
-# html_to_markdown
-
-This library is a refactored and modernized fork of [markdownify](https://pypi.org/project/markdownify/), supporting
-Python 3.9 and above.
-
-### Differences with the Markdownify
-
-- The refactored codebase uses a strict functional approach - no classes are involved.
-- There is full typing with strict MyPy strict adherence and a py.typed file included.
-- The `convert_to_markdown` function allows passing a pre-configured instance of `BeautifulSoup` instead of html.
-- This library releases follows standard semver. Its version v1.0.0 was branched from markdownify's v0.13.1, at which
-  point versioning is no longer aligned.
-
-## Installation
-
-```shell
-pip install html_to_markdown
-```
-
-## Usage
-
-Convert an string HTML to Markdown:
-
-```python
-from html_to_markdown import convert_to_markdown
-
-convert_to_markdown('<b>Yay</b> <a href="http://github.com">GitHub</a>')  # > '**Yay** [GitHub](http://github.com)'
-```
-
-Or pass a pre-configured instance of `BeautifulSoup`:
-
-```python
-from bs4 import BeautifulSoup
-from html_to_markdown import convert_to_markdown
-
-soup = BeautifulSoup('<b>Yay</b> <a href="http://github.com">GitHub</a>', 'lxml')  # lxml requires an extra dependency.
-
-convert_to_markdown(soup)  # > '**Yay** [GitHub](http://github.com)'
-```
-
-### Options
-
-The `convert_to_markdown` function accepts the following kwargs:
-
-- autolinks (bool): Automatically convert valid URLs into Markdown links. Defaults to True.
-- bullets (str): A string of characters to use for bullet points in lists. Defaults to '\*+-'.
-- code_language (str): Default language identifier for fenced code blocks. Defaults to an empty string.
-- code_language_callback (Callable[[Any], str] | None): Function to dynamically determine the language for code blocks.
-- convert (Iterable[str] | None): A list of tag names to convert to Markdown. If None, all supported tags are converted.
-- default_title (bool): Use the default title when converting certain elements (e.g., links). Defaults to False.
-- escape_asterisks (bool): Escape asterisks (\*) to prevent unintended Markdown formatting. Defaults to True.
-- escape_misc (bool): Escape miscellaneous characters to prevent conflicts in Markdown. Defaults to True.
-- escape*underscores (bool): Escape underscores (*) to prevent unintended italic formatting. Defaults to True.
-- heading_style (Literal["underlined", "atx", "atx_closed"]): The style to use for Markdown headings. Defaults to "
-  underlined".
-- keep_inline_images_in (Iterable[str] | None): Tags in which inline images should be preserved. Defaults to None.
-- newline_style (Literal["spaces", "backslash"]): Style for handling newlines in text content. Defaults to "spaces".
-- strip (Iterable[str] | None): Tags to strip from the output. Defaults to None.
-- strong*em_symbol (Literal["\*", "*"]): Symbol to use for strong/emphasized text. Defaults to "\*".
-- sub_symbol (str): Custom symbol for subscript text. Defaults to an empty string.
-- sup_symbol (str): Custom symbol for superscript text. Defaults to an empty string.
-- wrap (bool): Wrap text to the specified width. Defaults to False.
-- wrap_width (int): The number of characters at which to wrap text. Defaults to 80.
-- convert_as_inline (bool): Treat the content as inline elements (no block elements like paragraphs). Defaults to False.
-
-## CLI
-
-For compatibility with the original markdownify, a CLI is provided. Use `html_to_markdown example.html > example.md` or
-pipe input from stdin:
-
-```shell
-cat example.html | html_to_markdown > example.md
-```
-
-Use `html_to_markdown -h` to see all available options. They are the same as listed above and take the same arguments.

html_to_markdown-1.2.0/html_to_markdown/__init__.py

@@ -1,5 +0,0 @@
-from html_to_markdown.processing import convert_to_markdown
-
-from .legacy import Markdownify
-
-__all__ = ["Markdownify", "convert_to_markdown"]

html_to_markdown-1.2.0/html_to_markdown/legacy.py

@@ -1,89 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Literal
-
-from html_to_markdown.constants import ASTERISK, SPACES, UNDERLINED
-from html_to_markdown.converters import create_converters_map
-
-if TYPE_CHECKING:
-    from collections.abc import Callable, Iterable
-
-    from bs4 import Tag
-
-
-def _create_legacy_class(
-    autolinks: bool,
-    bullets: str,
-    code_language: str,
-    code_language_callback: Callable[[Tag], str] | None,
-    default_title: bool,
-    heading_style: Literal["atx", "atx_closed", "underlined"],
-    keep_inline_images_in: Iterable[str] | None,
-    newline_style: str,
-    strong_em_symbol: str,
-    sub_symbol: str,
-    sup_symbol: str,
-    wrap: bool,
-    wrap_width: int,
-) -> type:
-    """Create a legacy class for Markdownify.
-
-    Deprecated: Use the new hooks api instead.
-
-    Args:
-        autolinks: Whether to convert URLs into links.
-        bullets: The bullet characters to use for unordered lists.
-        code_language: The default code language to use.
-        code_language_callback: A callback to get the code language.
-        default_title: Whether to use the URL as the title for links.
-        heading_style: The style of headings.
-        keep_inline_images_in: The tags to keep inline images in.
-        newline_style: The style of newlines.
-        strong_em_symbol: The symbol to use for strong and emphasis text.
-        sub_symbol: The symbol to use for subscript text.
-        sup_symbol: The symbol to use for superscript text.
-        wrap: Whether to wrap text.
-        wrap_width: The width to wrap text at.
-
-    Returns:
-        A class that can be used to convert HTML to Markdown.
-    """
-    return type(
-        "Markdownify",
-        (),
-        {
-            k.removeprefix("_"): v
-            for k, v in create_converters_map(
-                autolinks=autolinks,
-                bullets=bullets,
-                code_language=code_language,
-                code_language_callback=code_language_callback,
-                default_title=default_title,
-                heading_style=heading_style,
-                keep_inline_images_in=keep_inline_images_in,
-                newline_style=newline_style,
-                strong_em_symbol=strong_em_symbol,
-                sub_symbol=sub_symbol,
-                sup_symbol=sup_symbol,
-                wrap=wrap,
-                wrap_width=wrap_width,
-            ).items()
-        },
-    )
-
-
-Markdownify = _create_legacy_class(
-    autolinks=True,
-    bullets="*+-",
-    code_language="",
-    code_language_callback=None,
-    default_title=False,
-    heading_style=UNDERLINED,
-    keep_inline_images_in=None,
-    newline_style=SPACES,
-    strong_em_symbol=ASTERISK,
-    sub_symbol="",
-    sup_symbol="",
-    wrap=False,
-    wrap_width=80,
-)