pyhtml2md 1.8.0__cp37-cp37m-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: pyhtml2md
|
|
3
|
+
Version: 1.8.0
|
|
4
|
+
Summary: Transform your HTML into clean, easy-to-read markdown with pyhtml2md.
|
|
5
|
+
Keywords: html,markdown,html-to-markdown,python3,cpp17,cpp-library,html2markdown,html2md
|
|
6
|
+
Author-Email: Tim Gromeyer <sakul8826@gmail.com>
|
|
7
|
+
License: MIT
|
|
8
|
+
Classifier: Intended Audience :: Developers
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Programming Language :: C++
|
|
11
|
+
Classifier: Programming Language :: Python
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
17
|
+
Classifier: Topic :: File Formats
|
|
18
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
19
|
+
Classifier: Topic :: Text Processing :: Markup :: HTML
|
|
20
|
+
Project-URL: Repository, https://github.com/tim-gromeyer/html2md
|
|
21
|
+
Requires-Python: >=3.7
|
|
22
|
+
Provides-Extra: test
|
|
23
|
+
Requires-Dist: pytest>=6.0; extra == "test"
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# pyhtml2md
|
|
27
|
+
|
|
28
|
+
pyhtml2md provides a way to use the html2md C++ library in Python. html2md is a fast and reliable library for converting HTML content into markdown.
|
|
29
|
+
|
|
30
|
+
<div class="hidable-toc">
|
|
31
|
+
|
|
32
|
+
- [Installation](#installation)
|
|
33
|
+
- [Basic usage](#basic-usage)
|
|
34
|
+
- [Advanced usage](#advanced-usage)
|
|
35
|
+
- [Supported Tags](#supported-tags)
|
|
36
|
+
- [License](#license)
|
|
37
|
+
|
|
38
|
+
</div>
|
|
39
|
+
|
|
40
|
+
<div id="doxygen-toc" style="visibility:hidden">
|
|
41
|
+
|
|
42
|
+
[TOC]
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
## Installation
|
|
48
|
+
|
|
49
|
+
You can install using pip:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pip3 install pyhtml2md
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Basic usage
|
|
56
|
+
|
|
57
|
+
Here is an example of how to use the pyhtml2md to convert HTML to markdown:
|
|
58
|
+
|
|
59
|
+
```python
|
|
60
|
+
import pyhtml2md
|
|
61
|
+
|
|
62
|
+
markdown = pyhtml2md.convert("<h1>Hello, world!</h1>")
|
|
63
|
+
print(markdown)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
The `convert` function takes an HTML string as input and returns a markdown string.
|
|
67
|
+
|
|
68
|
+
## Advanced usage
|
|
69
|
+
|
|
70
|
+
pyhtml2md provides a `Options` class to customize the generation process.
|
|
71
|
+
You can find all information on the c++ [documentation](https://tim-gromeyer.github.io/html2md/index.html)
|
|
72
|
+
|
|
73
|
+
Here is an example:
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
import pyhtml2md
|
|
77
|
+
|
|
78
|
+
options = pyhtml2md.Options()
|
|
79
|
+
options.splitLines = False
|
|
80
|
+
|
|
81
|
+
converter = pyhtml2md.Converter("<h1>Hello Python!</h1>", options)
|
|
82
|
+
markdown = converter.convert()
|
|
83
|
+
print(markdown)
|
|
84
|
+
print(converter.ok())
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Supported Tags
|
|
88
|
+
|
|
89
|
+
pyhtml2md supports the following HTML tags:
|
|
90
|
+
|
|
91
|
+
| Tag | Description | Comment |
|
|
92
|
+
|--------------|--------------------|-----------------------------------------------------|
|
|
93
|
+
| `a` | Anchor or link | Supports the `href`, `name` and `title` attributes. |
|
|
94
|
+
| `b` | Bold | |
|
|
95
|
+
| `blockquote` | Indented paragraph | |
|
|
96
|
+
| `br` | Line break | |
|
|
97
|
+
| `cite` | Inline citation | Same as `i`. |
|
|
98
|
+
| `code` | Code | |
|
|
99
|
+
| `dd` | Definition data | |
|
|
100
|
+
| `del` | Strikethrough | |
|
|
101
|
+
| `dfn` | Definition | Same as `i`. |
|
|
102
|
+
| `div` | Document division | |
|
|
103
|
+
| `em` | Emphasized | Same as `i`. |
|
|
104
|
+
| `h1` | Level 1 heading | |
|
|
105
|
+
| `h2` | Level 2 heading | |
|
|
106
|
+
| `h3` | Level 3 heading | |
|
|
107
|
+
| `h4` | Level 4 heading | |
|
|
108
|
+
| `h5` | Level 5 heading | |
|
|
109
|
+
| `h6` | Level 6 heading | |
|
|
110
|
+
| `head` | Document header | Ignored. |
|
|
111
|
+
| `hr` | Horizontal line | |
|
|
112
|
+
| `i` | Italic | |
|
|
113
|
+
| `img` | Image | Supports `src`, `alt`, `title` attributes. |
|
|
114
|
+
| `li` | List item | |
|
|
115
|
+
| `meta` | Meta-information | Ignored. |
|
|
116
|
+
| `ol` | Ordered list | |
|
|
117
|
+
| `p` | Paragraph | |
|
|
118
|
+
| `pre` | Preformatted text | Works only with `code`. |
|
|
119
|
+
| `s` | Strikethrough | Same as `del`. |
|
|
120
|
+
| `span` | Grouped elements | Does nothing. |
|
|
121
|
+
| `strong` | Strong | Same as `b`. |
|
|
122
|
+
| `table` | Table | Tables are formatted! |
|
|
123
|
+
| `tbody` | Table body | Does nothing. |
|
|
124
|
+
| `td` | Table data cell | Uses `align` from `th`. |
|
|
125
|
+
| `tfoot` | Table footer | Does nothing. |
|
|
126
|
+
| `th` | Table header cell | Supports the `align` attribute. |
|
|
127
|
+
| `thead` | Table header | Does nothing. |
|
|
128
|
+
| `title` | Document title | Same as `h1`. |
|
|
129
|
+
| `tr` | Table row | |
|
|
130
|
+
| `u` | Underlined | Uses HTML. |
|
|
131
|
+
| `ul` | Unordered list | |
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
pyhtml2md is licensed under [The MIT License (MIT)](https://opensource.org/licenses/MIT)
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
pyhtml2md.cp37-win_amd64.pyd,sha256=qwZ14kKU8iBwJlwbSw_3qY2RUmgr8SZlPkznBRzdAs8,248320
|
|
2
|
+
pyhtml2md-1.8.0.dist-info/METADATA,sha256=LKYyFt23F9mLhjGsVnF46pmklGPTpjeudqwfzqWQmUo,6230
|
|
3
|
+
pyhtml2md-1.8.0.dist-info/WHEEL,sha256=8Qrcszc_EgBzpzwCEIk4xbGhO_Cx6KXMNjPGW68ZaBc,105
|
|
4
|
+
pyhtml2md-1.8.0.dist-info/licenses/COPYING,sha256=X6r9FLs8Wtic3X3Vpf2ktCAtHDuUiQge-Z9vkCRrVnQ,1090
|
|
5
|
+
pyhtml2md-1.8.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Tim Gromeyer
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
Binary file
|