Metadata-Version: 2.0
Name: htmltextconvert
Version: 0.1.2
Summary: Convert HTML to plain text
Home-page: https://ollycope.com/repos/htmltextconvert
Author: Oliver Cope
Author-email: oliver@redgecko.org
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup

htmltextconvert: HTML to plain text converter
=============================================

htmltextconvert renders HTML to plain text, for example to autogenerate a plain
text versions of HTML emails, or to index HTML documents for search.

It differs from other packages in these ways:

- Pure Python, no dependencies
- High quality, well tested code
- Permissive license (Apache)
- Renders the HTML to text suitable for an text/plain email body (it doesn't
  aim to convert to a structured text format like markdown, but rather at giving
  a readable text-only representation of the rendered HTML).


Usage::

    >>> import htmltextconvert
    >>> print(
    ...     htmltextconvert.html_to_text(
    ...         """
    ...         <p>This is a paragraph.</p>
    ...         <p>This is another paragraph.</p>
    ...         """
    ...     )
    ... )
    This is a paragraph

    This is another paragraph


htmltextconvert handles the following HTML tags:

- Character entity references (``&name;``, ``&#nnnn;``, ``&#xhhhh``)
- Unordered lists (``<ul>``)
- Ordered lists (``<ol>``)
- Paragraphs (``<p>``)
- Block quotes (``<blockquote>``)
- Linebreaks (``<br>``)
- Links (``<a href="…">``)
- Bold (``<strong>``)
- Italic (``<em>``)
- Code (``<code>``)


