{"author":null,"author_email":"Aaron Swartz ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy"],"description":"# html2text\n\n[![CI](https://github.com/Alir3z4/html2text/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Alir3z4/html2text/actions/workflows/main.yml)\n[![codecov](https://codecov.io/gh/Alir3z4/html2text/graph/badge.svg?token=OoxiyymjgU)](https://codecov.io/gh/Alir3z4/html2text)\n\n\n\nhtml2text is a Python script that converts a page of HTML into clean, easy-to-read plain ASCII text. Better yet, that ASCII also happens to be valid Markdown (a text-to-HTML format).\n\n\nUsage: `html2text [filename [encoding]]`\n\n| Option | Description\n|--------------------------------------------------------|---------------------------------------------------\n| `--version` | Show program's version number and exit\n| `-h`, `--help` | Show this help message and exit\n| `--ignore-links` | Don't include any formatting for links\n|`--escape-all` | Escape all special characters. Output is less readable, but avoids corner case formatting issues.\n| `--reference-links` | Use reference links instead of links to create markdown\n| `--mark-code` | Mark preformatted and code blocks with [code]...[/code]\n\nFor a complete list of options see the [docs](https://github.com/Alir3z4/html2text/blob/master/docs/usage.md)\n\n\nOr you can use it from within `Python`:\n\n```\n>>> import html2text\n>>>\n>>> print(html2text.html2text(\"

Zed's dead baby, Zed's dead.

\"))\n**Zed's** dead baby, _Zed's_ dead.\n\n```\n\n\nOr with some configuration options:\n```\n>>> import html2text\n>>>\n>>> h = html2text.HTML2Text()\n>>> # Ignore converting links from HTML\n>>> h.ignore_links = True\n>>> print h.handle(\"

Hello, world!\")\nHello, world!\n\n>>> print(h.handle(\"

Hello, world!\"))\n\nHello, world!\n\n>>> # Don't Ignore links anymore, I like links\n>>> h.ignore_links = False\n>>> print(h.handle(\"

Hello, world!\"))\nHello, [world](https://www.google.com/earth/)!\n\n```\n\n*Originally written by Aaron Swartz. This code is distributed under the GPLv3.*\n\n\n## How to install\n\n`html2text` is available on pypi\nhttps://pypi.org/project/html2text/\n\n```shell\n$ pip install html2text\n```\n\n## Development\n\n### How to run unit tests\n\n```shell\n$ tox\n```\n\nTo see the coverage results:\n\n```shell\n$ coverage html\n```\n\nthen open the `./htmlcov/index.html` file in your browser.\n\n\n### Code Quality & Pre Commit\n\nThe CI runs several linting steps, including:\n\n- mypy\n- Flake8\n- Black\n\nTo make sure the code passes the CI linting steps, run:\n\n```shell\n$ tox -e pre-commit\n```\n\n## Documentation\n\nDocumentation lives [here](https://github.com/Alir3z4/html2text/blob/master/docs/usage.md)\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":null,"keywords":null,"license":null,"license_expression":"GPL-3.0-or-later","license_files":["COPYING","AUTHORS.rst"],"maintainer":null,"maintainer_email":"Alireza Savand ","name":"html2text","package_url":"https://pypi.org/project/html2text/","platform":"OS Independent","project_url":"https://pypi.org/project/html2text/","project_urls":{"Homepage":"https://github.com/Alir3z4/html2text/"},"provides_extra":null,"release_url":"https://pypi.org/project/html2text/2025.4.15/","requires_dist":null,"requires_python":">=3.9","summary":"Turn HTML into equivalent Markdown-structured text.","version":"2025.4.15","yanked":false,"yanked_reason":null}

Package search

html2text

project_urls

Dependencies

All package metadata

Releases