You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
4.2 KiB
116 lines
4.2 KiB
4 years ago
|
Metadata-Version: 2.1
|
||
|
|
Name: html2text
|
||
|
|
Version: 2020.1.16
|
||
|
|
Summary: Turn HTML into equivalent Markdown-structured text.
|
||
|
|
Home-page: https://github.com/Alir3z4/html2text/
|
||
|
|
Author: Aaron Swartz
|
||
|
|
Author-email: me@aaronsw.com
|
||
|
|
Maintainer: Alireza Savand
|
||
|
|
Maintainer-email: alireza.savand@gmail.com
|
||
|
|
License: GNU GPL 3
|
||
|
|
Platform: OS Independent
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||
|
|
Requires-Python: >=3.5
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
|
||
|
|
# html2text
|
||
|
|
|
||
|
|
[](https://travis-ci.org/Alir3z4/html2text)
|
||
|
|
[](https://coveralls.io/r/Alir3z4/html2text)
|
||
|
|
[](https://pypi.org/project/html2text/)
|
||
|
|
[](https://pypi.org/project/html2text/)
|
||
|
|
[](https://pypi.org/project/html2text/)
|
||
|
|
[](https://pypi.org/project/html2text/)
|
||
|
|
[](https://pypi.org/project/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 [filename [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](https://github.com/Alir3z4/html2text/blob/master/docs/usage.md)
|
||
|
|
|
||
|
|
|
||
|
|
Or you can use it from within `Python`:
|
||
|
|
|
||
|
|
```
|
||
|
|
>>> import html2text
|
||
|
|
>>>
|
||
|
|
>>> print(html2text.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 html2text
|
||
|
|
>>>
|
||
|
|
>>> h = html2text.HTML2Text()
|
||
|
|
>>> # Ignore converting links from HTML
|
||
|
|
>>> h.ignore_links = True
|
||
|
|
>>> print h.handle("<p>Hello, <a href='https://www.google.com/earth/'>world</a>!")
|
||
|
|
Hello, world!
|
||
|
|
|
||
|
|
>>> print(h.handle("<p>Hello, <a href='https://www.google.com/earth/'>world</a>!"))
|
||
|
|
|
||
|
|
Hello, world!
|
||
|
|
|
||
|
|
>>> # Don't Ignore links anymore, I like links
|
||
|
|
>>> h.ignore_links = False
|
||
|
|
>>> print(h.handle("<p>Hello, <a href='https://www.google.com/earth/'>world</a>!"))
|
||
|
|
Hello, [world](https://www.google.com/earth/)!
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
*Originally written by Aaron Swartz. This code is distributed under the GPLv3.*
|
||
|
|
|
||
|
|
|
||
|
|
## How to install
|
||
|
|
|
||
|
|
`html2text` is available on pypi
|
||
|
|
https://pypi.org/project/html2text/
|
||
|
|
|
||
|
|
```
|
||
|
|
$ pip install html2text
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## How to run unit tests
|
||
|
|
|
||
|
|
tox
|
||
|
|
|
||
|
|
To see the coverage results:
|
||
|
|
|
||
|
|
coverage html
|
||
|
|
|
||
|
|
then open the `./htmlcov/index.html` file in your browser.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
Documentation lives [here](https://github.com/Alir3z4/html2text/blob/master/docs/usage.md)
|
||
|
|
|
||
|
|
|