all2md 1.0.1__py3-none-any.whl

all2md/__init__.py

@@ -0,0 +1,303 @@
+"""all2md - A Python document conversion library for bidirectional transformation.
+
+all2md provides a comprehensive solution for converting between various file formats
+and Markdown. It supports PDF, Word (DOCX), PowerPoint (PPTX), HTML, email (EML),
+Excel (XLSX), Jupyter Notebooks (IPYNB), EPUB e-books, images, and 200+ text file formats with
+intelligent content extraction and formatting preservation.
+
+The library uses a modular architecture where the main `to_markdown()` function
+automatically detects file types and routes to appropriate specialized parsers.
+Each converter module handles specific format requirements while maintaining
+consistent Markdown output with support for tables, images, and complex formatting.
+
+Key Features
+------------
+- Advanced PDF parsing with table detection using PyMuPDF
+- Word document processing with formatting preservation
+- PowerPoint slide-by-slide extraction
+- HTML processing with configurable conversion options
+- Email chain parsing with attachment handling
+- Base64 image embedding support
+- Support for 200+ plaintext file formats
+- AST-based transformation pipeline for document manipulation
+- Plugin system for custom transforms via entry points
+
+Supported Formats
+-----------------
+- **Documents**: PDF, DOCX, PPTX, HTML, EML, EPUB
+- **Notebooks**: IPYNB (Jupyter Notebooks)
+- **Spreadsheets**: XLSX, CSV, TSV
+- **Images**: PNG, JPEG, GIF (embedded as base64)
+- **Text**: 200+ formats including code files, configs, markup
+
+Requirements
+------------
+- Python 3.10+
+- Optional dependencies loaded per format (PyMuPDF, python-docx, etc.)
+
+Examples
+--------
+Basic usage for file conversion:
+
+    >>> from all2md import to_markdown
+    >>> markdown_content = to_markdown('document.pdf')
+    >>> print(markdown_content)
+
+Using AST transforms to manipulate documents:
+
+    >>> from all2md import to_markdown
+    >>> from all2md.transforms import RemoveImagesTransform, HeadingOffsetTransform
+    >>>
+    >>> # Apply transforms during conversion
+    >>> markdown = to_markdown(
+    ...     'document.pdf',
+    ...     transforms=[
+    ...         RemoveImagesTransform(),
+    ...         HeadingOffsetTransform(offset=1)
+    ...     ]
+    ... )
+
+Working with the AST directly:
+
+    >>> from all2md import to_ast
+    >>> from all2md.transforms import render
+    >>>
+    >>> # Convert to AST
+    >>> doc = to_ast('document.pdf')
+    >>>
+    >>> # Apply transforms and render
+    >>> markdown = render(doc, transforms=['remove-images', 'heading-offset'])
+
+See Also
+--------
+all2md.transforms : AST transformation system
+all2md.ast : AST node definitions and utilities
+
+"""
+
+#  Copyright (c) 2025 Tom Villani, Ph.D.
+
+# Check Python version before any imports
+import sys
+
+if sys.version_info < (3, 10):
+    raise ImportError(
+        "all2md requires Python 3.10 or later. "
+        f"You are using Python {sys.version_info.major}.{sys.version_info.minor}."
+    )
+
+__version__ = "1.0.0"
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    # Import heavy modules for type checking without runtime overhead
+    from all2md import ast, parsers, transforms  # noqa: F401
+    from all2md.ast import Document  # noqa: F401 - used in docstrings
+
+    # Import all option classes for type checking
+    from all2md.options.asciidoc import AsciiDocOptions, AsciiDocRendererOptions  # noqa: F401
+    from all2md.options.chm import ChmOptions  # noqa: F401
+    from all2md.options.csv import CsvOptions  # noqa: F401
+    from all2md.options.docx import DocxOptions, DocxRendererOptions  # noqa: F401
+    from all2md.options.eml import EmlOptions  # noqa: F401
+    from all2md.options.epub import EpubOptions, EpubRendererOptions  # noqa: F401
+    from all2md.options.html import HtmlOptions, HtmlRendererOptions  # noqa: F401
+    from all2md.options.ipynb import IpynbOptions, IpynbRendererOptions  # noqa: F401
+    from all2md.options.latex import LatexOptions, LatexRendererOptions  # noqa: F401
+    from all2md.options.markdown import MarkdownParserOptions, MarkdownRendererOptions  # noqa: F401
+    from all2md.options.mediawiki import MediaWikiOptions  # noqa: F401
+    from all2md.options.mhtml import MhtmlOptions  # noqa: F401
+    from all2md.options.odp import OdpOptions  # noqa: F401
+    from all2md.options.ods import OdsSpreadsheetOptions  # noqa: F401
+    from all2md.options.odt import OdtOptions  # noqa: F401
+    from all2md.options.pdf import PdfOptions, PdfRendererOptions  # noqa: F401
+    from all2md.options.plaintext import PlainTextOptions  # noqa: F401
+    from all2md.options.pptx import PptxOptions, PptxRendererOptions  # noqa: F401
+    from all2md.options.rst import RstParserOptions, RstRendererOptions  # noqa: F401
+    from all2md.options.rtf import RtfOptions  # noqa: F401
+    from all2md.options.sourcecode import SourceCodeOptions  # noqa: F401
+    from all2md.options.xlsx import XlsxOptions  # noqa: F401
+    from all2md.options.zip import ZipOptions  # noqa: F401
+    from all2md.utils.input_sources import RemoteInputOptions  # noqa: F401
+
+from all2md.api import (
+    convert,
+    from_ast,
+    from_markdown,
+    to_ast,
+    to_markdown,
+)
+from all2md.constants import DocumentFormat
+
+# Extensions lists moved to constants.py - keep references for backward compatibility
+from all2md.converter_registry import registry
+from all2md.exceptions import All2MdError, DependencyError, FormatError, ParsingError
+
+# Keep only base and common option classes that are lightweight and frequently used
+from all2md.options.base import BaseParserOptions, BaseRendererOptions
+from all2md.options.common import LocalFileAccessOptions, NetworkFetchOptions
+from all2md.progress import ProgressCallback, ProgressEvent
+
+# Import parsers to trigger registration (must be eager, not lazy)
+from . import parsers  # noqa: F401
+
+# Lazy loading for heavy modules - only imported when accessed
+# This significantly improves CLI startup time by deferring AST and transforms
+# Note: parsers must be imported eagerly to trigger auto-discovery
+_lazy_modules = {
+    "ast": "all2md.ast",
+    "transforms": "all2md.transforms",
+}
+
+# Lazy loading for option classes - maps class name to (module_path, class_name)
+_lazy_options = {
+    "AsciiDocOptions": ("all2md.options.asciidoc", "AsciiDocOptions"),
+    "AsciiDocRendererOptions": ("all2md.options.asciidoc", "AsciiDocRendererOptions"),
+    "ChmOptions": ("all2md.options.chm", "ChmOptions"),
+    "CsvOptions": ("all2md.options.csv", "CsvOptions"),
+    "DocxOptions": ("all2md.options.docx", "DocxOptions"),
+    "DocxRendererOptions": ("all2md.options.docx", "DocxRendererOptions"),
+    "EmlOptions": ("all2md.options.eml", "EmlOptions"),
+    "EpubOptions": ("all2md.options.epub", "EpubOptions"),
+    "EpubRendererOptions": ("all2md.options.epub", "EpubRendererOptions"),
+    "HtmlOptions": ("all2md.options.html", "HtmlOptions"),
+    "HtmlRendererOptions": ("all2md.options.html", "HtmlRendererOptions"),
+    "IpynbOptions": ("all2md.options.ipynb", "IpynbOptions"),
+    "IpynbRendererOptions": ("all2md.options.ipynb", "IpynbRendererOptions"),
+    "LatexOptions": ("all2md.options.latex", "LatexOptions"),
+    "LatexRendererOptions": ("all2md.options.latex", "LatexRendererOptions"),
+    "MarkdownParserOptions": ("all2md.options.markdown", "MarkdownParserOptions"),
+    "MarkdownRendererOptions": ("all2md.options.markdown", "MarkdownRendererOptions"),
+    "MediaWikiOptions": ("all2md.options.mediawiki", "MediaWikiOptions"),
+    "MhtmlOptions": ("all2md.options.mhtml", "MhtmlOptions"),
+    "OdpOptions": ("all2md.options.odp", "OdpOptions"),
+    "OdsSpreadsheetOptions": ("all2md.options.ods", "OdsSpreadsheetOptions"),
+    "OdtOptions": ("all2md.options.odt", "OdtOptions"),
+    "PdfOptions": ("all2md.options.pdf", "PdfOptions"),
+    "PdfRendererOptions": ("all2md.options.pdf", "PdfRendererOptions"),
+    "PlainTextOptions": ("all2md.options.plaintext", "PlainTextOptions"),
+    "PptxOptions": ("all2md.options.pptx", "PptxOptions"),
+    "PptxRendererOptions": ("all2md.options.pptx", "PptxRendererOptions"),
+    "RstParserOptions": ("all2md.options.rst", "RstParserOptions"),
+    "RstRendererOptions": ("all2md.options.rst", "RstRendererOptions"),
+    "RtfOptions": ("all2md.options.rtf", "RtfOptions"),
+    "SourceCodeOptions": ("all2md.options.sourcecode", "SourceCodeOptions"),
+    "XlsxOptions": ("all2md.options.xlsx", "XlsxOptions"),
+    "ZipOptions": ("all2md.options.zip", "ZipOptions"),
+    "RemoteInputOptions": ("all2md.utils.input_sources", "RemoteInputOptions"),
+}
+
+# Options handling helpers
+
+
+__all__ = [
+    "__version__",
+    "to_markdown",
+    "to_ast",
+    "from_ast",
+    "from_markdown",
+    "convert",
+    # Registry system
+    "registry",
+    # Type definitions
+    "DocumentFormat",
+    # Progress system
+    "ProgressCallback",
+    "ProgressEvent",
+    # Re-exported classes and exceptions for public API
+    "BaseRendererOptions",
+    "BaseParserOptions",
+    "NetworkFetchOptions",
+    "LocalFileAccessOptions",
+    "AsciiDocRendererOptions",
+    "AsciiDocOptions",
+    "ChmOptions",
+    "CsvOptions",
+    "DocxOptions",
+    "DocxRendererOptions",
+    "EmlOptions",
+    "EpubOptions",
+    "EpubRendererOptions",
+    "HtmlRendererOptions",
+    "HtmlOptions",
+    "IpynbOptions",
+    "IpynbRendererOptions",
+    "LatexRendererOptions",
+    "LatexOptions",
+    "MarkdownRendererOptions",
+    "MarkdownParserOptions",
+    "MediaWikiOptions",
+    "MhtmlOptions",
+    "OdpOptions",
+    "OdsSpreadsheetOptions",
+    "OdtOptions",
+    "PdfOptions",
+    "PdfRendererOptions",
+    "PptxOptions",
+    "PptxRendererOptions",
+    "RstParserOptions",
+    "RstRendererOptions",
+    "RtfOptions",
+    "SourceCodeOptions",
+    "PlainTextOptions",
+    "XlsxOptions",
+    "ZipOptions",
+    "RemoteInputOptions",
+    # Exceptions
+    "DependencyError",
+    "All2MdError",
+    "FormatError",
+    "ParsingError",
+    # AST module (for advanced users)
+    "ast",
+    # Transforms module (for AST transformations)
+    "transforms",
+]
+
+
+def __getattr__(name: str) -> Any:
+    """Lazy load heavy modules and option classes on first access.
+
+    This function is called when an attribute is not found in the module namespace.
+    It allows us to defer importing heavy modules (ast, parsers, transforms) and
+    option classes until they are actually accessed, significantly improving CLI
+    startup time.
+
+    Parameters
+    ----------
+    name : str
+        The name of the attribute being accessed
+
+    Returns
+    -------
+    Any
+        The requested module, class, or attribute
+
+    Raises
+    ------
+    AttributeError
+        If the attribute is not found and is not a lazy-loadable item
+
+    """
+    import importlib
+
+    # Check if it's a lazy-loaded module
+    if name in _lazy_modules:
+        # nosemgrep: python.lang.security.audit.non-literal-import.non-literal-import
+        module = importlib.import_module(_lazy_modules[name])
+        # Cache the module in this module's namespace for faster future access
+        globals()[name] = module
+        return module
+
+    # Check if it's a lazy-loaded option class
+    if name in _lazy_options:
+        module_path, class_name = _lazy_options[name]
+        # nosemgrep: python.lang.security.audit.non-literal-import.non-literal-import
+        module = importlib.import_module(module_path)
+        cls = getattr(module, class_name)
+        # Cache the class in this module's namespace for faster future access
+        globals()[name] = cls
+        return cls
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

all2md/__main__.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+"""Entry point for running all2md as a module.
+
+This allows the package to be executed as:
+    python -m all2md [arguments]
+"""
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())

all2md/_plaintext-exts.json

@@ -0,0 +1,199 @@
+[
+  ".adoc",
+  ".asciidoc",
+  ".asm",
+  ".asp",
+  ".aspx",
+  ".atom",
+  ".awk",
+  ".babelrc",
+  ".bash",
+  ".bat",
+  ".bazel",
+  ".bib",
+  ".bzl",
+  ".c",
+  ".cfg",
+  ".cjs",
+  ".clj",
+  ".cmake",
+  ".cmd",
+  ".coffee",
+  ".conf",
+  ".config",
+  ".cpp",
+  ".cs",
+  ".csh",
+  ".cshtml",
+  ".cson",
+  ".css",
+  ".csv",
+  ".cypher",
+  ".d",
+  ".dart",
+  ".desktop",
+  ".diff",
+  ".dockerfile",
+  ".dtd",
+  ".editorconfig",
+  ".ejs",
+  ".el",
+  ".elm",
+  ".env",
+  ".erb",
+  ".erl",
+  ".eslintignore",
+  ".eslintrc",
+  ".ex",
+  ".exs",
+  ".f",
+  ".f90",
+  ".f95",
+  ".fish",
+  ".for",
+  ".fs",
+  ".gemspec",
+  ".geojson",
+  ".gitattributes",
+  ".gitignore",
+  ".gn",
+  ".go",
+  ".gql",
+  ".gradle",
+  ".graphql",
+  ".graphqlrc",
+  ".groovy",
+  ".gyp",
+  ".h",
+  ".haml",
+  ".hbs",
+  ".hcl",
+  ".hjson",
+  ".hpp",
+  ".hrl",
+  ".hs",
+  ".htaccess",
+  ".htm",
+  ".html",
+  ".htpasswd",
+  ".ics",
+  ".iml",
+  ".inf",
+  ".ini",
+  ".ipynb",
+  ".jade",
+  ".java",
+  ".jbuilder",
+  ".jenkinsfile",
+  ".jl",
+  ".js",
+  ".json5",
+  ".jsonld",
+  ".jsx",
+  ".ksh",
+  ".kt",
+  ".kts",
+  ".less",
+  ".liquid",
+  ".lisp",
+  ".log",
+  ".lua",
+  ".m",
+  ".mak",
+  ".make",
+  ".markdown",
+  ".md",
+  ".mdown",
+  ".mdwn",
+  ".mdx",
+  ".mediawiki",
+  ".mjs",
+  ".mkd",
+  ".mkdn",
+  ".mm",
+  ".mustache",
+  ".nfo",
+  ".nginx",
+  ".nim",
+  ".npmrc",
+  ".nsi",
+  ".nt",
+  ".opml",
+  ".org",
+  ".p",
+  ".pas",
+  ".patch",
+  ".php",
+  ".pl",
+  ".plist",
+  ".pod",
+  ".podspec",
+  ".pp",
+  ".prettierignore",
+  ".prisma",
+  ".pro",
+  ".properties",
+  ".proto",
+  ".ps1",
+  ".pug",
+  ".py",
+  ".pyx",
+  ".r",
+  ".rake",
+  ".rb",
+  ".rdoc",
+  ".reg",
+  ".rhtml",
+  ".robots",
+  ".rs",
+  ".rss",
+  ".rst",
+  ".sas",
+  ".sass",
+  ".sbt",
+  ".scala",
+  ".scm",
+  ".scss",
+  ".sed",
+  ".sgml",
+  ".sh",
+  ".shtml",
+  ".sitemap",
+  ".sql",
+  ".styl",
+  ".stylelintrc",
+  ".svelte",
+  ".svg",
+  ".swift",
+  ".tcl",
+  ".tex",
+  ".textile",
+  ".tf",
+  ".thor",
+  ".toml",
+  ".tpl",
+  ".ts",
+  ".tsv",
+  ".tsx",
+  ".ttl",
+  ".twig",
+  ".txt",
+  ".v",
+  ".vb",
+  ".vbhtml",
+  ".vcf",
+  ".vhd",
+  ".vim",
+  ".vue",
+  ".webmanifest",
+  ".wiki",
+  ".wsdl",
+  ".wsgi",
+  ".xaml",
+  ".xhtml",
+  ".xml",
+  ".xsd",
+  ".yaml",
+  ".yml",
+  ".zsh"
+]