markdown-pdf 1.11__tar.gz → 1.12__tar.gz
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.
- {markdown_pdf-1.11/markdown_pdf.egg-info → markdown_pdf-1.12}/PKG-INFO +5 -3
- {markdown_pdf-1.11 → markdown_pdf-1.12}/README.md +4 -2
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf/__init__.py +4 -12
- markdown_pdf-1.12/markdown_pdf/pligins/__init__.py +62 -0
- markdown_pdf-1.12/markdown_pdf/pligins/helpers.py +9 -0
- markdown_pdf-1.12/markdown_pdf/pligins/mermaid.py +25 -0
- markdown_pdf-1.12/markdown_pdf/pligins/plantuml.py +15 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12/markdown_pdf.egg-info}/PKG-INFO +5 -3
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf.egg-info/SOURCES.txt +2 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/pyproject.toml +4 -1
- markdown_pdf-1.11/markdown_pdf/pligins/__init__.py +0 -32
- markdown_pdf-1.11/markdown_pdf/pligins/plantuml.py +0 -26
- {markdown_pdf-1.11 → markdown_pdf-1.12}/LICENSE +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/MANIFEST.in +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf/py.typed +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf.egg-info/dependency_links.txt +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf.egg-info/requires.txt +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/markdown_pdf.egg-info/top_level.txt +0 -0
- {markdown_pdf-1.11 → markdown_pdf-1.12}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: markdown_pdf
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.12
|
|
4
4
|
Summary: Markdown to pdf renderer
|
|
5
5
|
Author-email: Vitaly Bogomolov <mail@vitaly-bogomolov.ru>
|
|
6
6
|
License-Expression: AGPL-3.0-only
|
|
@@ -33,7 +33,7 @@ Dynamic: license-file
|
|
|
33
33
|
[](https://app.codacy.com/gh/vb64/markdown-pdf/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
|
|
34
34
|
[](https://pypistats.org/packages/markdown-pdf)
|
|
35
35
|
|
|
36
|
-
The free, open source Python module `markdown-pdf` will create a PDF file from your
|
|
36
|
+
The free, open source Python module `markdown-pdf` will create a PDF file from your `markdown` content.
|
|
37
37
|
|
|
38
38
|
When creating a PDF file you can:
|
|
39
39
|
|
|
@@ -45,7 +45,7 @@ When creating a PDF file you can:
|
|
|
45
45
|
- Use different page sizes within single pdf
|
|
46
46
|
- Create tables in `markdown`
|
|
47
47
|
- Use clickable hyperlinks. Thanks a lot [@thongtmtrust](https://github.com/thongtmtrust) for ideas and collaboration.
|
|
48
|
-
-
|
|
48
|
+
- Render plantuml and mermaid code to pdf images with [plugins](plugins.md).
|
|
49
49
|
|
|
50
50
|
The module utilizes the functions of two great libraries.
|
|
51
51
|
|
|
@@ -234,6 +234,8 @@ In the created file `plantuml.pdf`, you will see the following result:
|
|
|
234
234
|
|
|
235
235
|

|
|
236
236
|
|
|
237
|
+
You can find a more detailed description of the plugins [here](plugins.md).
|
|
238
|
+
|
|
237
239
|
## Example
|
|
238
240
|
|
|
239
241
|
As an example, you can download the [pdf file](examples/markdown_pdf.pdf) created from this md file.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
[](https://app.codacy.com/gh/vb64/markdown-pdf/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
|
|
7
7
|
[](https://pypistats.org/packages/markdown-pdf)
|
|
8
8
|
|
|
9
|
-
The free, open source Python module `markdown-pdf` will create a PDF file from your
|
|
9
|
+
The free, open source Python module `markdown-pdf` will create a PDF file from your `markdown` content.
|
|
10
10
|
|
|
11
11
|
When creating a PDF file you can:
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ When creating a PDF file you can:
|
|
|
18
18
|
- Use different page sizes within single pdf
|
|
19
19
|
- Create tables in `markdown`
|
|
20
20
|
- Use clickable hyperlinks. Thanks a lot [@thongtmtrust](https://github.com/thongtmtrust) for ideas and collaboration.
|
|
21
|
-
-
|
|
21
|
+
- Render plantuml and mermaid code to pdf images with [plugins](plugins.md).
|
|
22
22
|
|
|
23
23
|
The module utilizes the functions of two great libraries.
|
|
24
24
|
|
|
@@ -207,6 +207,8 @@ In the created file `plantuml.pdf`, you will see the following result:
|
|
|
207
207
|
|
|
208
208
|

|
|
209
209
|
|
|
210
|
+
You can find a more detailed description of the plugins [here](plugins.md).
|
|
211
|
+
|
|
210
212
|
## Example
|
|
211
213
|
|
|
212
214
|
As an example, you can download the [pdf file](examples/markdown_pdf.pdf) created from this md file.
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
"""Markdown to pdf converter based on markdown_it and fitz."""
|
|
2
|
-
import os
|
|
3
2
|
import io
|
|
4
3
|
import typing
|
|
5
4
|
import pathlib
|
|
@@ -9,18 +8,11 @@ from markdown_it import MarkdownIt
|
|
|
9
8
|
from pymupdf import (
|
|
10
9
|
_as_pdf_document, mupdf, JM_embedded_clean, JM_ensure_identity, JM_new_output_fileptr, ASSERT_PDF, Rect,
|
|
11
10
|
)
|
|
12
|
-
from .pligins import PLUGINS, get_plugin_chunks
|
|
11
|
+
from .pligins import PLUGINS, get_plugin_chunks, TempFiles
|
|
13
12
|
|
|
14
13
|
MM_2_PT = 2.835
|
|
15
14
|
|
|
16
15
|
|
|
17
|
-
def clear_temp_files(files):
|
|
18
|
-
"""Remove temp files from given list."""
|
|
19
|
-
for i in files:
|
|
20
|
-
if os.path.exists(i):
|
|
21
|
-
os.remove(i)
|
|
22
|
-
|
|
23
|
-
|
|
24
16
|
class Section:
|
|
25
17
|
"""Markdown section."""
|
|
26
18
|
|
|
@@ -76,7 +68,7 @@ class MarkdownPdf:
|
|
|
76
68
|
self.toc_level = toc_level
|
|
77
69
|
self.toc = []
|
|
78
70
|
self.plugins = plugins or {}
|
|
79
|
-
self.temp_files =
|
|
71
|
+
self.temp_files = TempFiles()
|
|
80
72
|
|
|
81
73
|
# zero, commonmark, js-default, gfm-like
|
|
82
74
|
# https://markdown-it-py.readthedocs.io/en/latest/using.html#quick-start
|
|
@@ -155,7 +147,7 @@ class MarkdownPdf:
|
|
|
155
147
|
else:
|
|
156
148
|
doc.save(file_name)
|
|
157
149
|
doc.close()
|
|
158
|
-
|
|
150
|
+
self.temp_files.clean()
|
|
159
151
|
|
|
160
152
|
def save_bytes(self, bytesio: io.BytesIO) -> int:
|
|
161
153
|
"""Save pdf to file-like object and return byte size of the filled object."""
|
|
@@ -191,6 +183,6 @@ class MarkdownPdf:
|
|
|
191
183
|
out = JM_new_output_fileptr(bytesio)
|
|
192
184
|
mupdf.pdf_write_document(pdf, out, opts)
|
|
193
185
|
out.fz_close_output()
|
|
194
|
-
|
|
186
|
+
self.temp_files.clean()
|
|
195
187
|
|
|
196
188
|
return bytesio.getbuffer().nbytes
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"""Plugins."""
|
|
2
|
+
import os
|
|
3
|
+
import uuid
|
|
4
|
+
|
|
5
|
+
from .plantuml import handler as plantuml_handler
|
|
6
|
+
from .mermaid import handler as mermaid_handler
|
|
7
|
+
|
|
8
|
+
PLUGINS = {}
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class Plugin:
|
|
12
|
+
"""Available plugins."""
|
|
13
|
+
|
|
14
|
+
Plantuml = "plantuml"
|
|
15
|
+
Mermaid = "mermaid"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class TempFiles:
|
|
19
|
+
"""Temp files for plugins."""
|
|
20
|
+
|
|
21
|
+
def __init__(self):
|
|
22
|
+
"""Init empty list."""
|
|
23
|
+
self.name_list = []
|
|
24
|
+
|
|
25
|
+
def new_name(self, ext=None):
|
|
26
|
+
"""Return file name with given extension."""
|
|
27
|
+
self.name_list.append(str(uuid.uuid4()) + ".{}".format(ext) if ext else '')
|
|
28
|
+
return self.name_list[-1]
|
|
29
|
+
|
|
30
|
+
def clean(self):
|
|
31
|
+
"""Remove temp files."""
|
|
32
|
+
for i in self.name_list:
|
|
33
|
+
if os.path.exists(i):
|
|
34
|
+
os.remove(i)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
def register(key, handler):
|
|
38
|
+
"""Register plugin as available."""
|
|
39
|
+
PLUGINS[key] = handler
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
def get_plugin_chunks(key, text):
|
|
43
|
+
"""Extract key parts from given text."""
|
|
44
|
+
chunk = []
|
|
45
|
+
chunks = []
|
|
46
|
+
|
|
47
|
+
for line in text.splitlines():
|
|
48
|
+
|
|
49
|
+
if line.startswith("```{}".format(key)):
|
|
50
|
+
chunk = [line]
|
|
51
|
+
elif (line.startswith("```")) and chunk:
|
|
52
|
+
chunk.append(line)
|
|
53
|
+
chunks.append('\n'.join(chunk))
|
|
54
|
+
chunk = []
|
|
55
|
+
elif chunk:
|
|
56
|
+
chunk.append(line)
|
|
57
|
+
|
|
58
|
+
return chunks
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
register(Plugin.Plantuml, plantuml_handler)
|
|
62
|
+
register(Plugin.Mermaid, mermaid_handler)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"""Mermaid plugin."""
|
|
2
|
+
import base64
|
|
3
|
+
import requests
|
|
4
|
+
|
|
5
|
+
from .helpers import get_key
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def handler(params_dict, text, temp_files):
|
|
9
|
+
"""Translate mermaid marked text to png image."""
|
|
10
|
+
url = get_key(params_dict, 'url', 'https://mermaid.ink/img/')
|
|
11
|
+
code = '\n'.join(text.splitlines()[1:-1])
|
|
12
|
+
response = requests.get(
|
|
13
|
+
"{}{}".format(
|
|
14
|
+
url,
|
|
15
|
+
base64.urlsafe_b64encode(code.encode("utf-8")).decode("ascii"),
|
|
16
|
+
),
|
|
17
|
+
params={"format": "png"},
|
|
18
|
+
timeout=5
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
file_name = temp_files.new_name(ext="png")
|
|
22
|
+
with open(file_name, mode='wb') as out:
|
|
23
|
+
out.write(response.content)
|
|
24
|
+
|
|
25
|
+
return "\n\n".format(file_name)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""Plantunl plugin."""
|
|
2
|
+
from plantuml import PlantUML
|
|
3
|
+
from .helpers import get_key
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def handler(params_dict, text, temp_files):
|
|
7
|
+
"""Translate plantunl marked text to png image."""
|
|
8
|
+
url = get_key(params_dict, 'url', 'http://www.plantuml.com/plantuml/img/')
|
|
9
|
+
image = PlantUML(url=url).processes('\n'.join(text.splitlines()[1:-1]))
|
|
10
|
+
file_name = temp_files.new_name("png")
|
|
11
|
+
|
|
12
|
+
with open(file_name, mode='wb') as out:
|
|
13
|
+
out.write(image)
|
|
14
|
+
|
|
15
|
+
return "\n\n".format(file_name)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: markdown_pdf
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.12
|
|
4
4
|
Summary: Markdown to pdf renderer
|
|
5
5
|
Author-email: Vitaly Bogomolov <mail@vitaly-bogomolov.ru>
|
|
6
6
|
License-Expression: AGPL-3.0-only
|
|
@@ -33,7 +33,7 @@ Dynamic: license-file
|
|
|
33
33
|
[](https://app.codacy.com/gh/vb64/markdown-pdf/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
|
|
34
34
|
[](https://pypistats.org/packages/markdown-pdf)
|
|
35
35
|
|
|
36
|
-
The free, open source Python module `markdown-pdf` will create a PDF file from your
|
|
36
|
+
The free, open source Python module `markdown-pdf` will create a PDF file from your `markdown` content.
|
|
37
37
|
|
|
38
38
|
When creating a PDF file you can:
|
|
39
39
|
|
|
@@ -45,7 +45,7 @@ When creating a PDF file you can:
|
|
|
45
45
|
- Use different page sizes within single pdf
|
|
46
46
|
- Create tables in `markdown`
|
|
47
47
|
- Use clickable hyperlinks. Thanks a lot [@thongtmtrust](https://github.com/thongtmtrust) for ideas and collaboration.
|
|
48
|
-
-
|
|
48
|
+
- Render plantuml and mermaid code to pdf images with [plugins](plugins.md).
|
|
49
49
|
|
|
50
50
|
The module utilizes the functions of two great libraries.
|
|
51
51
|
|
|
@@ -234,6 +234,8 @@ In the created file `plantuml.pdf`, you will see the following result:
|
|
|
234
234
|
|
|
235
235
|

|
|
236
236
|
|
|
237
|
+
You can find a more detailed description of the plugins [here](plugins.md).
|
|
238
|
+
|
|
237
239
|
## Example
|
|
238
240
|
|
|
239
241
|
As an example, you can download the [pdf file](examples/markdown_pdf.pdf) created from this md file.
|
|
@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
|
|
|
7
7
|
|
|
8
8
|
[project]
|
|
9
9
|
name = "markdown_pdf"
|
|
10
|
-
version = "1.
|
|
10
|
+
version = "1.12"
|
|
11
11
|
description = "Markdown to pdf renderer"
|
|
12
12
|
readme = { file = "README.md", content-type = "text/markdown" }
|
|
13
13
|
requires-python = ">=3.8"
|
|
@@ -54,3 +54,6 @@ filterwarnings = [
|
|
|
54
54
|
'ignore:builtin type SwigPyObject has no __module__ attribute:DeprecationWarning',
|
|
55
55
|
'ignore:builtin type SwigPyPacked has no __module__ attribute:DeprecationWarning',
|
|
56
56
|
]
|
|
57
|
+
markers = [
|
|
58
|
+
'external: marks a test as uses external resources'
|
|
59
|
+
]
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
"""Plugins."""
|
|
2
|
-
from .plantuml import handler as plantuml_handler
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
class Plugin:
|
|
6
|
-
"""Available plugins."""
|
|
7
|
-
|
|
8
|
-
Plantuml = "plantuml"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
PLUGINS = {
|
|
12
|
-
Plugin.Plantuml: plantuml_handler,
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
def get_plugin_chunks(key, text):
|
|
17
|
-
"""Extract key parts from given text."""
|
|
18
|
-
chunk = []
|
|
19
|
-
chunks = []
|
|
20
|
-
|
|
21
|
-
for line in text.splitlines():
|
|
22
|
-
|
|
23
|
-
if line.startswith("```{}".format(key)):
|
|
24
|
-
chunk = [line]
|
|
25
|
-
elif (line.startswith("```")) and chunk:
|
|
26
|
-
chunk.append(line)
|
|
27
|
-
chunks.append('\n'.join(chunk))
|
|
28
|
-
chunk = []
|
|
29
|
-
elif chunk:
|
|
30
|
-
chunk.append(line)
|
|
31
|
-
|
|
32
|
-
return chunks
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
"""Plantunl plugin."""
|
|
2
|
-
import os
|
|
3
|
-
import tempfile
|
|
4
|
-
from plantuml import PlantUML
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
def handler(params_dict, text, temp_files):
|
|
8
|
-
"""Translate plantunl marked text to png image."""
|
|
9
|
-
url = params_dict.get("url")
|
|
10
|
-
if not url:
|
|
11
|
-
return "No value for 'url' key in plantuml plugin parameters: {}".format(params_dict)
|
|
12
|
-
|
|
13
|
-
text = '\n'.join(text.splitlines()[1:-1])
|
|
14
|
-
server = PlantUML(url=url)
|
|
15
|
-
image = server.processes(text)
|
|
16
|
-
file_name = ''
|
|
17
|
-
|
|
18
|
-
with tempfile.NamedTemporaryFile(mode='wb', delete=False, suffix=".png") as tmp_file:
|
|
19
|
-
file_name = os.path.basename(tmp_file.name)
|
|
20
|
-
temp_files.append(tmp_file.name)
|
|
21
|
-
|
|
22
|
-
with open(file_name, mode='wb') as out:
|
|
23
|
-
temp_files.append(file_name)
|
|
24
|
-
out.write(image)
|
|
25
|
-
|
|
26
|
-
return "\n\n".format(file_name)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|