Skip to main content

Turn HTML into equivalent Markdown-structured text. Telegram adapted.

Project description

html2texttg

Build Status Downloads Version Wheel? Format License

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

Markdown supported by telegram

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

Option Description
--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
--escape-all Escape all special characters. Output is less readable, but avoids corner case formatting issues.
--reference-links Use reference links instead of links to create markdown
--mark-code Mark preformatted and code blocks with [code]...[/code]

For a complete list of options see the docs

Or you can use it from within Python:

>>> import html2texttg
>>>
>>> print(html2texttg.html2text("<p><strong>Zed's</strong> dead baby, <em>Zed's</em> dead.</p>"))
**Zed's** dead baby, _Zed's_ dead.

Or with some configuration options:

>>> import html2texttg
>>>
>>> h = html2texttg.HTML2Text()
>>> # Ignore converting links from HTML
>>> h.ignore_links = True
>>> print h.handle("<p>Hello, <a href='http://earth.google.com/'>world</a>!")
Hello, world!

>>> print(h.handle("<p>Hello, <a href='http://earth.google.com/'>world</a>!"))

Hello, world!

>>> # Don't Ignore links anymore, I like links
>>> h.ignore_links = False
>>> print(h.handle("<p>Hello, <a href='http://earth.google.com/'>world</a>!"))
Hello, [world](http://earth.google.com/)!

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

How to install

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

$ pip install html2texttg

How to run unit tests

$ python -m unittest

Documentation

Documentation lives here

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

html2texttg-1.0.3.tar.gz (36.6 kB view details)

Uploaded Source

File details

Details for the file html2texttg-1.0.3.tar.gz.

File metadata

  • Download URL: html2texttg-1.0.3.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.0

File hashes

Hashes for html2texttg-1.0.3.tar.gz
Algorithm Hash digest
SHA256 09fcb327832553f13fd27a5196213f9f59efbe076f00c692f7798738d4beef37
MD5 6e0b0d46e1883988841269aef2499c00
BLAKE2b-256 4d33c97406e9026f2daef28b1b03ae6574e5b19a67b51a05b2c280d13a62297b

See more details on using hashes here.

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