markdown_convert 1.2.21__py3-none-any.whl → 1.2.23__py3-none-any.whl

markdown_convert/__main__.py

@@ -32,8 +32,8 @@ def main():
 
         # Get the markdown path
         try:
-            md_path = arg["markdown_file_path"]
-            validate_markdown_path(md_path)
+            markdown_path = arg["markdown_file_path"]
+            validate_markdown_path(markdown_path)
         except KeyError as key_err:
             raise IndexError("Missing 'markdown_file_path' argument.") from key_err
         except Exception as exc:
@@ -61,18 +61,18 @@ def main():
         try:
             output_path = arg["--out"]
             validate_output_path(output_path)
-            output_path = get_output_path(md_path, output_path)
+            output_path = get_output_path(markdown_path, output_path)
         except KeyError:
-            output_path = get_output_path(md_path, None)
+            output_path = get_output_path(markdown_path, None)
         except Exception as exc:
             raise IndexError(f"Invalid 'output_path' argument: {exc}") from exc
 
         # Compile the markdown file
-        print(f"\nGenerating PDF file from '{md_path}'...\n")
+        print(f"\nGenerating PDF file from '{markdown_path}'...\n")
         if mode in ("once", "debug"):
-            convert(md_path, css_path, output_path, dump_html=mode == "debug")
+            convert(markdown_path, css_path, output_path, dump_html=mode == "debug")
         else:
-            live_convert(md_path, css_path, output_path)
+            live_convert(markdown_path, css_path, output_path)
 
         sys_exit(0)
 

markdown_convert/modules/constants.py

@@ -14,7 +14,7 @@ OPTIONS = ("markdown_file_path", "--mode", "--css", "--out", "-h", "--help")
 
 OPTIONS_MODES = ("once", "live", "debug")
 
-MD_EXTENSIONS = {
+MARKDOWN_EXTENSIONS = {
     "fenced-code-blocks": None,
     "header-ids": True,
     "breaks": {"on_newline": True},

markdown_convert/modules/convert.py

@@ -12,7 +12,7 @@ from pathlib import Path
 import markdown2
 from playwright.sync_api import sync_playwright
 
-from .constants import MD_EXTENSIONS
+from .constants import MARKDOWN_EXTENSIONS
 from .resources import get_code_css_path, get_css_path, get_output_path
 from .utils import drop_duplicates
 
@@ -35,8 +35,8 @@ def _generate_pdf_with_playwright(
         base_dir (Path, optional): Base directory for resolving relative paths in HTML.
         dump_html (bool, optional): Whether to dump the HTML content to a file.
     """
-    with sync_playwright() as p:
-        browser = p.chromium.launch(headless=True)
+    with sync_playwright() as playwright:
+        browser = playwright.chromium.launch(headless=True)
         page = browser.new_page()
 
         # Handle loading based on presence of base_dir
@@ -55,7 +55,12 @@ def _generate_pdf_with_playwright(
             pdf_params = {
                 "format": "A4",
                 "print_background": True,
-                "margin": {"top": "20mm", "bottom": "20mm", "left": "20mm", "right": "20mm"},
+                "margin": {
+                    "top": "20mm",
+                    "bottom": "20mm",
+                    "left": "20mm",
+                    "right": "20mm",
+                },
                 "path": output_path,
             }  # Playwright ignores None paths
 
@@ -101,7 +106,7 @@ def _create_sections(html):
 
 
 def convert(
-    md_path,
+    markdown_path,
     css_path=None,
     output_path=None,
     *,
@@ -112,7 +117,7 @@ def convert(
     Convert a markdown file to a pdf file.
 
     Args:
-        md_path (str): Path to the markdown file.
+        markdown_path (str): Path to the markdown file.
         css_path (str=None): Path to the CSS file.
         output_path (str=None): Path to the output file.
         extend_default_css (bool=True): Extend the default CSS file.
@@ -122,7 +127,7 @@ def convert(
         css_path = get_css_path()
 
     if output_path is None:
-        output_path = get_output_path(md_path, None)
+        output_path = get_output_path(markdown_path, None)
 
     if extend_default_css:
         css_sources = [get_code_css_path(), get_css_path(), css_path]
@@ -132,14 +137,14 @@ def convert(
     css_sources = drop_duplicates(css_sources)
 
     try:
-        html = markdown2.markdown_path(md_path, extras=MD_EXTENSIONS)
+        html = markdown2.markdown_path(markdown_path, extras=MARKDOWN_EXTENSIONS)
         html = _create_sections(html)
 
         _generate_pdf_with_playwright(
             html,
             output_path,
             css_content=_get_css_content(css_sources),
-            base_dir=Path(md_path).resolve().parent,
+            base_dir=Path(markdown_path).resolve().parent,
             dump_html=dump_html,
         )
 
@@ -147,12 +152,14 @@ def convert(
         raise RuntimeError(exc) from exc
 
 
-def live_convert(md_path, css_path=None, output_path=None, *, extend_default_css=True):
+def live_convert(
+    markdown_path, css_path=None, output_path=None, *, extend_default_css=True
+):
     """
     Convert a markdown file to a pdf file and watch for changes.
 
     Args:
-        md_path (str): Path to the markdown file.
+        markdown_path (str): Path to the markdown file.
         css_path (str=None): Path to the CSS file.
         output_path (str=None): Path to the output file.
         extend_default_css (bool=True): Extend the default CSS file.
@@ -161,10 +168,10 @@ def live_convert(md_path, css_path=None, output_path=None, *, extend_default_css
         css_path = get_css_path()
 
     if output_path is None:
-        output_path = get_output_path(md_path, None)
+        output_path = get_output_path(markdown_path, None)
 
     live_converter = LiveConverter(
-        md_path,
+        markdown_path,
         css_path,
         output_path,
         extend_default_css=extend_default_css,
@@ -173,12 +180,12 @@ def live_convert(md_path, css_path=None, output_path=None, *, extend_default_css
     live_converter.observe()
 
 
-def convert_text(md_text, css_text=None, *, extend_default_css=True):
+def convert_text(markdown_text, css_text=None, *, extend_default_css=True):
     """
     Convert markdown text to a pdf file.
 
     Args:
-        md_text (str): Markdown text.
+        markdown_text (str): Markdown text.
         css_text (str=None): CSS text.
         extend_default_css (bool=True): Extend the default CSS file.
 
@@ -197,7 +204,7 @@ def convert_text(md_text, css_text=None, *, extend_default_css=True):
         css_sources = [code_css, css_text]
 
     try:
-        html = markdown2.markdown(md_text, extras=MD_EXTENSIONS)
+        html = markdown2.markdown(markdown_text, extras=MARKDOWN_EXTENSIONS)
         html = _create_sections(html)
 
         return _generate_pdf_with_playwright(
@@ -215,17 +222,25 @@ class LiveConverter:
     Class to convert a markdown file to a pdf file and watch for changes.
     """
 
-    def __init__(self, md_path, css_path, output_path, *, extend_default_css=True, loud=False):
+    def __init__(
+        self,
+        markdown_path,
+        css_path,
+        output_path,
+        *,
+        extend_default_css=True,
+        loud=False,
+    ):
         """
         Initialize the LiveConverter class.
 
         Args:
-            md_path (str): Path to the markdown file.
+            markdown_path (str): Path to the markdown file.
             css_path (str): Path to the CSS file.
             output_path (str): Path to the output file.
             extend_default_css (bool): Extend the default CSS file.
         """
-        self.md_path = Path(md_path).absolute()
+        self.md_path = Path(markdown_path).absolute()
         self.css_path = Path(css_path).absolute()
         self.output_path = output_path
         self.extend_default_css = extend_default_css
@@ -272,14 +287,17 @@ class LiveConverter:
         try:
             while True:
 
-                md_modified = self.get_last_modified_date(self.md_path)
+                markdown_modified = self.get_last_modified_date(self.md_path)
                 css_modified = self.get_last_modified_date(self.css_path)
 
-                if md_modified != self.md_last_modified or css_modified != self.css_last_modified:
+                if (
+                    markdown_modified != self.md_last_modified
+                    or css_modified != self.css_last_modified
+                ):
 
                     self.write_pdf()
 
-                    self.md_last_modified = md_modified
+                    self.md_last_modified = markdown_modified
                     self.css_last_modified = css_modified
 
                 time.sleep(poll_interval)

markdown_convert/modules/resources.py

@@ -17,28 +17,28 @@ from .constants import BLUE, CYAN, GREEN, YELLOW, OPTIONS, OPTIONS_MODES
 from .utils import color
 
 
-def get_output_path(md_path, output_dir=None):
+def get_output_path(markdown_path, output_dir=None):
     """
     Get the output path for the pdf file.
 
     Args:
-        md_path (str): The path to the markdown file.
+        markdown_path (str): The path to the markdown file.
         output_dir (str): The output directory.
 
     Returns:
         str: The output path.
     """
-    md_path = Path(md_path)
+    markdown_path = Path(markdown_path)
 
     if output_dir is None:
-        return md_path.parent / f"{md_path.stem}.pdf"
+        return markdown_path.parent / f"{markdown_path.stem}.pdf"
 
     output_dir = Path(output_dir)
 
     if output_dir.suffix == ".pdf":
         return output_dir
 
-    return output_dir.parent / f"{Path(md_path).stem}.pdf"
+    return output_dir.parent / f"{Path(markdown_path).stem}.pdf"
 
 
 def get_css_path():
@@ -76,11 +76,14 @@ def get_usage():
         f"{color(GREEN, 'markdown-convert')} "
         f"[{color(YELLOW, OPTIONS[0])}] [{color(BLUE, 'options')}]"
     )
-    opt_1 = f"{color(BLUE, OPTIONS[1])}{color(CYAN, '=')}{color(CYAN, '|'.join(OPTIONS_MODES))}"
-    opt_2 = (
+    option_one = (
+        f"{color(BLUE, OPTIONS[1])}{color(CYAN, '=')}"
+        f"{color(CYAN, '|'.join(OPTIONS_MODES))}"
+    )
+    option_two = (
         f"{color(BLUE, OPTIONS[2])}{color(CYAN, '=')}[{color(CYAN, 'css_file_path')}]"
     )
-    opt_3 = f"{color(BLUE, OPTIONS[3])}{color(CYAN, '=')}[{color(CYAN, 'output_file_path')}]"
+    option_three = f"{color(BLUE, OPTIONS[3])}{color(CYAN, '=')}[{color(CYAN, 'output_file_path')}]"
 
     usage = (
         "\n"
@@ -88,11 +91,11 @@ def get_usage():
         f"  {commd}\n"
         "\n"
         "Options:\n"
-        f"  {opt_1}\n"
+        f"  {option_one}\n"
         "    Convert the markdown file once (default) or live.\n"
-        f"  {opt_2}\n"
+        f"  {option_two}\n"
         "    Use a custom CSS file.\n"
-        f"  {opt_3}\n"
+        f"  {option_three}\n"
         "    Specify the output file path.\n"
     )
     return usage

markdown_convert/modules/validate.py

@@ -6,21 +6,21 @@ Author: @julynx
 from pathlib import Path
 
 
-def validate_markdown_path(md_path):
+def validate_markdown_path(markdown_path):
     """
     Validate the markdown file path.
 
     Args:
-        md_path (str): The path to the markdown file.
+        markdown_path (str): The path to the markdown file.
 
     Raises:
         FileNotFoundError: If the file is not found.
         ValueError: If the file is not a Markdown file.
     """
-    if not Path(md_path).is_file():
-        raise FileNotFoundError(f"File not found: '{md_path}'")
+    if not Path(markdown_path).is_file():
+        raise FileNotFoundError(f"File not found: '{markdown_path}'")
 
-    if not md_path.endswith(".md"):
+    if not markdown_path.endswith(".md"):
         raise ValueError("File must be a Markdown file.")
 
 

markdown_convert-1.2.23.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: markdown_convert
+Version: 1.2.23
+Summary: Convert Markdown files to PDF from your command line.
+Project-URL: homepage, https://github.com/Julynx/markdown_convert
+Author-email: Julio Cabria <juliocabria@tutanota.com>
+License: GPL-2.0-only
+License-File: LICENSE
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <3.15,>=3.9
+Requires-Dist: argsdict==1.0.0
+Requires-Dist: latex2mathml>=3.78.1
+Requires-Dist: markdown2<3,>=2.4.13
+Requires-Dist: playwright>=1.57.0
+Requires-Dist: pygments<3,>=2.17.2
+Description-Content-Type: text/markdown
+
+# markdown-convert
+
+_Convert Markdown files to PDF from your command line._
+
+`pip install markdown-convert`
+
+<br>
+
+[![Button Hover](https://img.shields.io/badge/Github-c9510c?style=for-the-badge)](https://github.com/Julynx/markdown-convert)
+[![Button Hover](https://img.shields.io/badge/PyPi-006dad?style=for-the-badge)](https://pypi.org/project/markdown_convert)
+
+<br>
+
+<img src='https://i.imgur.com/uWDm7s0.png' width='80%'>
+
+----
+
+- [markdown-convert](#markdown-convert)
+  - [Why `markdown-convert`?](#why-markdown-convert)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [1. From your terminal](#1-from-your-terminal)
+    - [2. As a Python library](#2-as-a-python-library)
+    - [3. From the context menu of your file explorer](#3-from-the-context-menu-of-your-file-explorer)
+
+## Why `markdown-convert`?
+
+Unlike other similar tools, `markdown-convert`:
+
+- Can be fully installed via `pip install markdown-convert`, with no external system-level dependencies.
+- Comes with a sensible default CSS stylesheet out of the box.
+- Supports:
+  - **LaTeX math equations:** `$...$` for inline and `$$...$$` for block equations.
+  - **Syntax highlighting for code blocks:** Applied automatically based on the specified language.
+  - **Live conversion:** `markdown-convert file.md --mode=live` updates the PDF every time the Markdown file changes.
+  - **Custom CSS** `markdown-convert file.md --css=style.css` extends the default CSS with your own stylesheet.
+  - **Pipe tables, header links, CSS paged media features and more!**
+
+## Installation
+
+`markdown-convert` is available on PyPI and can be installed via pip:
+
+```bash
+pip install markdown-convert
+```
+
+## Usage
+
+### 1. From your terminal
+
+Simply run `markdown-convert file.md` to convert `file.md` to `file.pdf`.
+
+You can specify the following options:
+
+- `--mode=once|live`: Convert the markdown file once (default) or live.
+- `--css=[css_file_path]`: Use a custom CSS file.
+- `--out=[output_file_path]`: Specify the output file path.
+
+For example: `markdown-convert README.md --mode=live --css=style.css --out=output.pdf` will convert `README.md` to `output.pdf` using `style.css` and update the PDF live as you edit the Markdown file.
+
+### 2. As a Python library
+
+You can also use `markdown-convert` as a library in your Python code:
+
+```python
+from markdown_convert import convert, convert_text, live_convert
+
+# Convert your Markdown file and save it as a PDF file
+convert('README.md', 'style.css', 'README.pdf')
+
+# Convert your Markdown string and get the PDF bytes
+pdf_bytes = convert_text('# Hello World', 'h1 { color: red; }')
+
+# Convert your Markdown file to PDF every time it changes
+live_convert('README.md', 'style.css', 'README.pdf')
+```
+
+### 3. From the context menu of your file explorer
+
+Install the extension of your choice:
+
+- For Windows Explorer: [markdown_convert_explorer](https://github.com/Julynx/markdown_convert_explorer)
+- For Linux (Nautilus): [markdown_convert_nautilus](https://github.com/Julynx/markdown_convert_nautilus)
+
+Then right click any Markdown file and select `Convert to PDF` to convert it.

markdown_convert-1.2.23.dist-info/RECORD

@@ -0,0 +1,15 @@
+markdown_convert/__init__.py,sha256=ysW3pXsDGGK4PzZHcIBTpfVW58IkDUwHffDkf_GM6UU,303
+markdown_convert/__main__.py,sha256=hO7AO0GnzPMPNqls8r5aF2C-7l9aFHDf1m8mXSy1GBE,2809
+markdown_convert/code.css,sha256=Wt4FqFqJcpT-jwY3GN-o4ZRCCXU8DQj-9lqKdGiuoyw,4935
+markdown_convert/default.css,sha256=sTIJmfRWOe8SVwlhzw9CSXD44TUtgfjKCHJjf6u2O8U,2877
+markdown_convert/modules/__init__.py,sha256=PFPgiQhMXgyfjD8BkfLC_X8AR1jz-dCxfif2qmNofJs,65
+markdown_convert/modules/constants.py,sha256=Pdm-yoTuvUQbqWiufiydTeuA5ysSF_ZuAafRBrnXPt8,454
+markdown_convert/modules/convert.py,sha256=MPr6CM-KNtfHEnPv0sVegOd26mlmG_v49C55MYXjW_M,8718
+markdown_convert/modules/resources.py,sha256=tnW8JmCrJNBRbzOcaOVG6GX5jPC8Kzj3dA7gX0B935A,2488
+markdown_convert/modules/utils.py,sha256=NX0WegM8e8MPKNNmweTujAWO8ZghdB8LSGDx20K2E44,655
+markdown_convert/modules/validate.py,sha256=XV_k7cHeifEKDaltF26tCmabs2-Me5msP3enI_eVwfA,1517
+markdown_convert-1.2.23.dist-info/METADATA,sha256=llxbzt0ME2aa4n_mucnYoLgFyxkWytJlrnhMIRjLOwg,3797
+markdown_convert-1.2.23.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+markdown_convert-1.2.23.dist-info/entry_points.txt,sha256=RCmzC7C0sX-SpzIP2Cr34rhg3lMd7BRx-exaZPfK8bU,68
+markdown_convert-1.2.23.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+markdown_convert-1.2.23.dist-info/RECORD,,

markdown_convert-1.2.21.dist-info/METADATA

@@ -1,79 +0,0 @@
-Metadata-Version: 2.4
-Name: markdown_convert
-Version: 1.2.21
-Summary: Convert Markdown files to PDF from your command line.
-Project-URL: homepage, https://github.com/Julynx/markdown_convert
-Author-email: Julio Cabria <juliocabria@tutanota.com>
-License: GPL-2.0-only
-License-File: LICENSE
-Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: <3.15,>=3.9
-Requires-Dist: argsdict==1.0.0
-Requires-Dist: latex2mathml>=3.78.1
-Requires-Dist: markdown2<3,>=2.4.13
-Requires-Dist: playwright>=1.57.0
-Requires-Dist: pygments<3,>=2.17.2
-Description-Content-Type: text/markdown
-
-# markdown-convert
-
-_Convert Markdown files to PDF from your command line._
-
-### `pip install markdown-convert`
-
-<br>
-
-[![Button Hover](https://img.shields.io/badge/Github-c9510c?style=for-the-badge)](https://github.com/Julynx/markdown-convert)
-[![Button Hover](https://img.shields.io/badge/PyPi-006dad?style=for-the-badge)](https://pypi.org/project/markdown_convert)
-
-<br>
-
-<img src='https://i.imgur.com/SZIz2gY.png' width='80%'>
-
-`markdown-convert` is an elegant command-line tool that converts Markdown files to PDF, powered by the amazing `markdown2` and `playwright` libraries.
-
-Unlike other similar tools, it relies solely on Python packages to do the job, eliminating the need for any external system-level dependencies.
-
-### Features
-
-- ⚡️ Supports live compilation, so you can preview your PDF in real-time as you type.
-- 🌸 Comes with beautiful CSS out of the box, making your documents look great from the start.
-- 🎨 Syntax highlighting for code blocks included.
-- 🪐 Designed for the 21st century, with relative links, pipe tables, and modern CSS paged media features.
-
-### Usage
-
-> Note: If you just installed the package, you may need to log out and log back in for the `markdown-convert` command to be registered to your PATH.
-
-Run `markdown-convert -h` right from your terminal to check out the available options:
-
-```bash
-Usage:
-  markdown-convert [markdown_file_path] [options]
-
-Options:
-  --mode=once|live
-    Convert the markdown file once (default) or live.
-  --css=[css_file_path]
-    Use a custom CSS file.
-  --out=[output_file_path]
-    Specify the output file path.
-```
-
-...or import any of the functions from the package to use them in your own code:
-
-```python
-from markdown_convert import convert, live_convert
-
-# Convert your Markdown file to PDF once
-convert('README.md', 'style.css', 'README.pdf')
-
-# Convert your Markdown file to PDF every time it changes
-live_convert('README.md', 'style.css', 'README.pdf')
-```
-
-### Integrations
-
-Right click a Markdown file and `Convert to PDF` with the [markdown_convert_explorer](https://github.com/Julynx/markdown_convert_explorer) and [markdown_convert_nautilus](https://github.com/Julynx/markdown_convert_nautilus) extensions for Windows and Linux.

markdown_convert-1.2.21.dist-info/RECORD

@@ -1,15 +0,0 @@
-markdown_convert/__init__.py,sha256=ysW3pXsDGGK4PzZHcIBTpfVW58IkDUwHffDkf_GM6UU,303
-markdown_convert/__main__.py,sha256=zKgFcnxlXTRsR6AYhTdGEvQea2TVyLYeIxJSMksCMR0,2767
-markdown_convert/code.css,sha256=Wt4FqFqJcpT-jwY3GN-o4ZRCCXU8DQj-9lqKdGiuoyw,4935
-markdown_convert/default.css,sha256=sTIJmfRWOe8SVwlhzw9CSXD44TUtgfjKCHJjf6u2O8U,2877
-markdown_convert/modules/__init__.py,sha256=PFPgiQhMXgyfjD8BkfLC_X8AR1jz-dCxfif2qmNofJs,65
-markdown_convert/modules/constants.py,sha256=Yd7o0OGwliYcmBGrwoeckagc9E8p1l-zXQx_P4CuiK4,448
-markdown_convert/modules/convert.py,sha256=cU-wATfsM5Y8WFklkw7NIa2KSrMpc50aZecO4rewua8,8346
-markdown_convert/modules/resources.py,sha256=aMDbM7Oab8A3nRN1tc1uNkmz8JfUdLJR6rF3ZR0IElo,2384
-markdown_convert/modules/utils.py,sha256=NX0WegM8e8MPKNNmweTujAWO8ZghdB8LSGDx20K2E44,655
-markdown_convert/modules/validate.py,sha256=cerfQ5Qt8gBQbh-NZ57zLmDfg-Vnyo0zsEFb8RUzVCQ,1487
-markdown_convert-1.2.21.dist-info/METADATA,sha256=ugunfrpmL6ivecjGLKnQvMmLNlU0w4qvPPm-kvizRF4,2935
-markdown_convert-1.2.21.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-markdown_convert-1.2.21.dist-info/entry_points.txt,sha256=RCmzC7C0sX-SpzIP2Cr34rhg3lMd7BRx-exaZPfK8bU,68
-markdown_convert-1.2.21.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-markdown_convert-1.2.21.dist-info/RECORD,,