markdown_convert 1.2.7__tar.gz → 1.2.11__tar.gz

markdown_convert-1.2.11/.gitignore

@@ -0,0 +1,164 @@
+deploy
+clean
+test
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

{markdown_convert-1.2.7 → markdown_convert-1.2.11}/PKG-INFO

@@ -1,24 +1,20 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: markdown_convert
-Version: 1.2.7
+Version: 1.2.11
 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
-Author: Julio Cabria
-Author-email: juliocabria@tutanota.com
-Requires-Python: >=3.9,<4.0
+License-File: LICENSE
 Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: argsdict (==1.0.0)
-Requires-Dist: markdown2 (>=2.4.13,<3.0.0)
-Requires-Dist: pygments (>=2.17.2,<3.0.0)
-Requires-Dist: setuptools (>=46.0.0)
-Requires-Dist: weasyprint (>=62.3,<70.0)
-Project-URL: Homepage, https://github.com/Julynx/markdown_convert
+Requires-Python: <4.0,>=3.9
+Requires-Dist: argsdict==1.0.0
+Requires-Dist: markdown2<3,>=2.4.13
+Requires-Dist: pygments<3,>=2.17.2
+Requires-Dist: setuptools>=46.0.0
+Requires-Dist: weasyprint<70.0,>=62.3
 Description-Content-Type: text/markdown
 
 # markdown-convert
@@ -83,4 +79,3 @@ 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.11/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "markdown_convert"
+version = "1.2.11"
+description = "Convert Markdown files to PDF from your command line."
+authors = [
+    { name = "Julio Cabria", email = "juliocabria@tutanota.com" },
+]
+license = { text = "GPL-2.0-only" }
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "argsdict==1.0.0",
+    "setuptools>=46.0.0",
+    "weasyprint>=62.3,<70.0",
+    "markdown2>=2.4.13,<3",
+    "pygments>=2.17.2,<3",
+]
+
+[project.urls]
+homepage = "https://github.com/Julynx/markdown_convert"
+
+[project.scripts]
+markdown-convert = "markdown_convert.__main__:main"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "markdown_convert/default.css",
+    "markdown_convert/code.css",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["markdown_convert"]

markdown_convert-1.2.7/markdown_convert/__init__.py

@@ -1,8 +0,0 @@
-"""
-This file is used to import all the functions from the modules and make them
-available to the user.
-Author: @julynx
-"""
-
-from __main__ import *
-from .modules.convert import convert, live_convert, convert_text

markdown_convert-1.2.7/markdown_convert/__main__.py

@@ -1,96 +0,0 @@
-#!/usr/bin/env python3
-
-"""
-CLI interface to convert markdown files to pdf.
-Author: @julynx
-"""
-
-
-from sys import exit as sys_exit
-
-from argsdict import args
-from .modules.constants import RED, OPTIONS, OPTIONS_MODES
-from .modules.convert import convert, live_convert
-from .modules.resources import get_css_path, get_output_path, get_usage
-from .modules.utils import color
-from .modules.validate import (validate_css_path, validate_markdown_path,
-                               validate_output_path)
-
-
-def main():
-    """
-    Convert a markdown file to a pdf file.
-    """
-    try:
-        # Load and validate arguments
-        arg = args(["markdown_file_path"])
-        for key in set(arg.keys()) - set(OPTIONS):
-            raise IndexError(f"Invalid option: '{key}'")
-
-        # Get the markdown path
-        try:
-            md_path = arg["markdown_file_path"]
-            validate_markdown_path(md_path)
-        except KeyError as key_err:
-            raise IndexError("Missing 'markdown_file_path' argument.") \
-                from key_err
-        except Exception as exc:
-            raise IndexError(f"Invalid 'markdown_file_path' argument: {exc}") \
-                from exc
-
-        # Get the mode
-        try:
-            mode = arg["--mode"]
-            if mode not in OPTIONS_MODES:
-                raise ValueError(f"Invalid mode: '{mode}'")
-        except KeyError:
-            mode = "once"
-
-        # Get the CSS path
-        try:
-            css_path = arg["--css"]
-            validate_css_path(css_path)
-        except KeyError:
-            css_path = get_css_path()
-        except Exception as exc:
-            raise IndexError(f"Invalid 'css_file_path' argument: {exc}") \
-                from exc
-
-        # Get the output path
-        output_path = None
-        try:
-            output_path = arg["--out"]
-            validate_output_path(output_path)
-            output_path = get_output_path(md_path, output_path)
-        except KeyError:
-            output_path = get_output_path(md_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')
-        if mode == "once":
-            convert(md_path, css_path, output_path)
-        else:
-            live_convert(md_path, css_path, output_path)
-
-        sys_exit(0)
-
-    except Exception as err:
-
-        asked_for_help = "--help" in arg or "-h" in arg
-        show_usage = (isinstance(err, (IndexError, ValueError))
-                      or asked_for_help)
-
-        if show_usage:
-            print(get_usage())
-
-        if not asked_for_help:
-            print(color(RED, f"ERROR: {err}\n"))
-
-        sys_exit(1)
-
-
-if __name__ == '__main__':
-    main()

markdown_convert-1.2.7/markdown_convert/modules/__init__.py

@@ -1,4 +0,0 @@
-"""
-Empty file to make the folder a package.
-Author: @julynx
-"""

markdown_convert-1.2.7/markdown_convert/modules/constants.py

@@ -1,24 +0,0 @@
-"""
-This module contains the constants used in the markdown_convert package.
-Author: @julynx
-"""
-
-RED = '31'
-GREEN = '32'
-YELLOW = '33'
-BLUE = '34'
-MAGENTA = '35'
-CYAN = '36'
-
-OPTIONS = ('markdown_file_path',
-           "--mode",
-           '--css',
-           "--out",
-           "-h", "--help")
-
-OPTIONS_MODES = ('once', 'live')
-
-MD_EXTENSIONS = ["fenced-code-blocks",
-                 "header-ids",
-                 "breaks",
-                 "tables"]

markdown_convert-1.2.7/markdown_convert/modules/convert.py

@@ -1,194 +0,0 @@
-"""
-Module to convert a markdown file to a pdf file.
-Author: @julynx
-"""
-
-import os
-import time
-from datetime import datetime
-from pathlib import Path
-
-import markdown2
-import weasyprint
-
-from .resources import get_css_path, get_code_css_path, get_output_path
-from .utils import drop_duplicates
-from .constants import MD_EXTENSIONS
-
-
-def convert(md_path, css_path=None, output_path=None,
-            *, extend_default_css=True):
-    """
-    Convert a markdown file to a pdf file.
-
-    Args:
-        md_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.
-    """
-    if css_path is None:
-        css_path = get_css_path()
-
-    if output_path is None:
-        output_path = get_output_path(md_path, None)
-
-    if extend_default_css:
-        css_sources = [get_code_css_path(), get_css_path(), css_path]
-    else:
-        css_sources = [get_code_css_path(), css_path]
-
-    css_sources = drop_duplicates(css_sources)
-
-    try:
-        html = markdown2.markdown_path(md_path,
-                                       extras=MD_EXTENSIONS)
-
-        (weasyprint
-         .HTML(string=html, base_url='.')
-         .write_pdf(target=output_path,
-                    stylesheets=list(css_sources)))
-
-    except Exception as exc:
-        raise RuntimeError(exc) from exc
-
-
-def live_convert(md_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.
-        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.
-    """
-    if css_path is None:
-        css_path = get_css_path()
-
-    if output_path is None:
-        output_path = get_output_path(md_path, None)
-
-    live_converter = LiveConverter(md_path, css_path, output_path,
-                                   extend_default_css=extend_default_css,
-                                   loud=True)
-    live_converter.observe()
-
-
-def convert_text(md_text, css_text=None,
-                 *, extend_default_css=True):
-    """
-    Convert markdown text to a pdf file.
-
-    Args:
-        md_text (str): Markdown text.
-        css_text (str=None): CSS text.
-        extend_default_css (bool=True): Extend the default CSS file.
-
-    Returns:
-        PDF file as bytes.
-    """
-    default_css = Path(get_css_path()).read_text(encoding='utf-8')
-    code_css = Path(get_code_css_path()).read_text(encoding='utf-8')
-
-    if css_text is None:
-        css_text = default_css
-
-    if extend_default_css:
-        css_sources = [code_css, default_css, css_text]
-    else:
-        css_sources = [code_css, css_text]
-
-    css_sources = [weasyprint.CSS(string=css)
-                   for css in drop_duplicates(css_sources)]
-
-    try:
-        html = markdown2.markdown(md_text,
-                                  extras=MD_EXTENSIONS)
-
-        return (weasyprint
-                .HTML(string=html, base_url='.')
-                .write_pdf(stylesheets=css_sources))
-
-    except Exception as exc:
-        raise RuntimeError(exc) from exc
-
-
-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):
-        """
-        Initialize the LiveConverter class.
-
-        Args:
-            md_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.css_path = Path(css_path).absolute()
-        self.output_path = output_path
-        self.extend_default_css = extend_default_css
-        self.loud = loud
-
-        self.md_last_modified = None
-        self.css_last_modified = None
-
-    def get_last_modified_date(self, file_path):
-        """
-        Get the last modified date of a file.
-
-        Args:
-            file_path (str): Path to the file.
-
-        Returns:
-            Last modified date of the file.
-        """
-        return os.path.getmtime(file_path)
-
-    def write_pdf(self):
-        """
-        Write the pdf file.
-        """
-        convert(self.md_path, self.css_path, self.output_path,
-                extend_default_css=self.extend_default_css)
-        if self.loud:
-            print(f"- PDF file updated: {datetime.now()}", flush=True)
-
-    def observe(self, poll_interval=1):
-        """
-        Observe the markdown and CSS files. Calls write_pdf() when a file is
-        modified.
-        """
-        self.write_pdf()
-
-        self.md_last_modified = self.get_last_modified_date(self.md_path)
-        self.css_last_modified = self.get_last_modified_date(self.css_path)
-
-        try:
-            while True:
-
-                md_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:
-
-                    self.write_pdf()
-
-                    self.md_last_modified = md_modified
-                    self.css_last_modified = css_modified
-
-                time.sleep(poll_interval)
-
-        except KeyboardInterrupt:
-            if self.loud:
-                print("\nInterrupted by user.\n", flush=True)
-            return

markdown_convert-1.2.7/markdown_convert/modules/resources.py

@@ -1,85 +0,0 @@
-"""
-This module contains functions that are used to get the output path, the CSS
-path, and the usage message.
-Author: @julynx
-"""
-
-from pathlib import Path
-
-import pkg_resources
-
-from .constants import BLUE, CYAN, GREEN, YELLOW, OPTIONS, OPTIONS_MODES
-from .utils import color
-
-
-def get_output_path(md_path, output_dir=None):
-    """
-    Get the output path for the pdf file.
-
-    Args:
-        md_path (str): The path to the markdown file.
-        output_dir (str): The output directory.
-
-    Returns:
-        str: The output path.
-    """
-    md_path = Path(md_path)
-
-    if output_dir is None:
-        return md_path.parent / f"{md_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"
-
-
-def get_css_path():
-    """
-    Get the path to the default CSS file.
-
-    Returns:
-        str: The path to the default CSS file.
-    """
-    return pkg_resources.resource_filename('markdown_convert',
-                                           'default.css')
-
-
-def get_code_css_path():
-    """
-    Get the path to the code CSS file.
-
-    Returns:
-        str: The path to the code CSS file.
-    """
-    return pkg_resources.resource_filename('markdown_convert',
-                                           'code.css')
-
-
-def get_usage():
-    """
-    Returns a message describing how to use the program.
-
-    Returns:
-        str: The usage message.
-    """
-    commd = (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 = 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')}]"
-
-    usage = ("\n"
-             "Usage:\n"
-             f"  {commd}\n"
-             "\n"
-             "Options:\n"
-             f"  {opt_1}\n"
-             "    Convert the markdown file once (default) or live.\n"
-             f"  {opt_2}\n"
-             "    Use a custom CSS file.\n"
-             f"  {opt_3}\n"
-             "    Specify the output file path.\n")
-    return usage

markdown_convert-1.2.7/markdown_convert/modules/utils.py

@@ -1,38 +0,0 @@
-"""
-Utility functions for string manipulation.
-Author: @julynx
-"""
-
-import platform
-
-
-def color(color_code, text):
-    """
-    Colorize text.
-
-    Args:
-        text (str): The text to colorize.
-        color (str): The color code.
-
-    Returns:
-        str: The colorized text.
-    """
-
-    # Disable if running on Windows
-    if platform.system() == "Windows":
-        return text
-
-    return f"\033[{color_code}m{text}\033[0m"
-
-
-def drop_duplicates(lst):
-    """
-    Drops duplicates from the given list.
-
-    Args:
-        lst: List to remove duplicates from.
-
-    Returns:
-        List without duplicates.
-    """
-    return list(dict.fromkeys(lst))

markdown_convert-1.2.7/markdown_convert/modules/validate.py

@@ -1,61 +0,0 @@
-"""
-This module contains functions to validate the input paths.
-Author: @julynx
-"""
-
-from pathlib import Path
-
-
-def validate_markdown_path(md_path):
-    """
-    Validate the markdown file path.
-
-    Args:
-        md_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 md_path.endswith(".md"):
-        raise ValueError("File must be a Markdown file.")
-
-
-def validate_css_path(css_path):
-    """
-    Validate the CSS file path.
-
-    Args:
-        css_path (str): The path to the CSS file.
-
-    Raises:
-        FileNotFoundError: If the file is not found.
-        ValueError: If the file is not a CSS file.
-    """
-    if not Path(css_path).is_file():
-        raise FileNotFoundError(f"File not found: '{css_path}'")
-
-    if not css_path.endswith(".css"):
-        raise ValueError("File must be a CSS file.")
-
-
-def validate_output_path(output_dir):
-    """
-    Validate the output directory path.
-
-    Args:
-        output_dir (str): The path to the output directory.
-
-    Raises:
-        FileNotFoundError: If the directory is not found.
-    """
-    check_dir = Path(output_dir)
-
-    if output_dir.endswith(".pdf"):
-        check_dir = check_dir.parent
-
-    if not check_dir.is_dir():
-        raise FileNotFoundError(f"Directory not found: '{check_dir}'")

markdown_convert-1.2.7/pyproject.toml

@@ -1,24 +0,0 @@
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "markdown_convert"
-version = "1.2.7"
-description = "Convert Markdown files to PDF from your command line."
-authors = ["Julio Cabria <juliocabria@tutanota.com>"]
-license = "GPL-2.0-only"
-readme = "README.md"
-homepage = "https://github.com/Julynx/markdown_convert"
-include = ["markdown_convert/default.css", "markdown_convert/code.css"]
-
-[tool.poetry.dependencies]
-python = ">=3.9,<4.0"
-argsdict = "1.0.0"
-setuptools = ">=46.0.0"
-weasyprint = ">=62.3,<70.0"
-markdown2 = "^2.4.13"
-pygments = "^2.17.2"
-
-[tool.poetry.scripts]
-markdown-convert = "markdown_convert.__main__:main"