Skip to main content

Turn HTML into equivalent Markdown-structured text.

Project description

# [html2text](http://www.aaronsw.com/2002/html2text/)

[![Build Status](https://secure.travis-ci.org/html2text/html2text.png)](http://travis-ci.org/html2text/html2text) [![Coverage Status](https://coveralls.io/repos/htmL2text/html2text/badge.png)](https://coveralls.io/r/htmL2text/html2text)

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: html2text.py [(filename|url) [encoding]]

Options:
--version show program’s version number and exit
-h, --help show this help message and exit
--ignore-links don’t include any formatting for links
--ignore-images
 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=’http://earth.google.com/’>world</a>!”)

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

## How to install

html2text is available on pypi https://pypi.python.org/pypi/html2text

` $ pip install html2text `

## How to run unit tests

python test/test_html2text.py -v

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
html2text-2014.7.3.tar.gz (32.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page