Skip to main content

Turn HTML into equivalent Markdown-structured text.

Project description

# [html2text](

[![Build Status](](

html2text 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).

Usage: [(filename|url) [encoding]]


show program’s version number and exit

-h, --help

show this help message and exit


don’t include any formatting for links


don’t include any formatting for images

-g, --google-doc

convert an html-exported Google Document

-d, --dash-unordered-list

use a dash rather than a star for unordered list items

-b BODY_WIDTH, --body-width=BODY_WIDTH

number of characters per output line, 0 for no wrap

-i LIST_INDENT, --google-list-indent=LIST_INDENT

number of pixels Google indents nested lists

-s, --hide-strikethrough

hide strike-through text. only relevent when -g is specified as well

Or you can use it from within Python:

import html2text print html2text.html2text(“<p>Hello, world.</p>”)

Or with some configuration options:

import html2text h = html2text.HTML2Text() h.ignore_links = True print h.handle(“<p>Hello, <a href=’’>world</a>!”)

_Originally written by Aaron Swartz. This code is distributed under the GPLv3._

## How to install

html2text is available on pypi

` $ pip install html2text `

## How to do a release

  1. Update the version in

  2. Update the version in

  3. Run python sdist upload

## How to run unit tests

python test/ -v

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html2text-2014.4.5.tar.gz (25.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page