mdify-cli 1.4.1__py3-none-any.whl → 1.6.0__py3-none-any.whl

mdify/__init__.py

@@ -1,3 +1,3 @@
 """mdify - Convert documents to Markdown via Docling container."""
 
-__version__ = "1.4.1"
+__version__ = "1.6.0"

mdify/cli.py

@@ -37,10 +37,11 @@ SUPPORTED_RUNTIMES = ("docker", "podman")
 # Update checking functions
 # =============================================================================
 
+
 def _get_remote_version(timeout: int = 5) -> Optional[str]:
     """
     Fetch the latest version from PyPI.
-    
+
     Returns:
         Version string (e.g., "1.1.0") or None if fetch failed.
     """
@@ -56,16 +57,16 @@ def _get_remote_version(timeout: int = 5) -> Optional[str]:
 def _should_check_for_update() -> bool:
     """
     Determine if we should check for updates based on last check time.
-    
+
     Returns:
         True if check should be performed, False otherwise.
     """
     if os.environ.get("MDIFY_NO_UPDATE_CHECK", "").lower() in ("1", "true", "yes"):
         return False
-    
+
     if not LAST_CHECK_FILE.exists():
         return True
-    
+
     try:
         last_check = float(LAST_CHECK_FILE.read_text().strip())
         elapsed = time.time() - last_check
@@ -86,18 +87,18 @@ def _update_last_check_time() -> None:
 def _compare_versions(current: str, remote: str) -> bool:
     """
     Compare version strings.
-    
+
     Returns:
         True if remote version is newer than current.
     """
     try:
         current_parts = [int(x) for x in current.split(".")]
         remote_parts = [int(x) for x in remote.split(".")]
-        
+
         max_len = max(len(current_parts), len(remote_parts))
         current_parts.extend([0] * (max_len - len(current_parts)))
         remote_parts.extend([0] * (max_len - len(remote_parts)))
-        
+
         return remote_parts > current_parts
     except (ValueError, AttributeError):
         return False
@@ -106,15 +107,15 @@ def _compare_versions(current: str, remote: str) -> bool:
 def check_for_update(force: bool = False) -> None:
     """
     Check for updates and prompt user to upgrade if available.
-    
+
     Args:
         force: If True, check regardless of last check time and show errors.
     """
     if not force and not _should_check_for_update():
         return
-    
+
     remote_version = _get_remote_version()
-    
+
     if remote_version is None:
         if force:
             print(
@@ -124,19 +125,19 @@ def check_for_update(force: bool = False) -> None:
             )
             sys.exit(1)
         return
-    
+
     _update_last_check_time()
-    
+
     if not _compare_versions(__version__, remote_version):
         if force:
             print(f"mdify is up to date (version {__version__})")
         return
-    
-    print(f"\n{'='*50}")
+
+    print(f"\n{'=' * 50}")
     print(f"A new version of mdify-cli is available!")
     print(f"  Current version: {__version__}")
     print(f"  Latest version:  {remote_version}")
-    print(f"{'='*50}")
+    print(f"{'=' * 50}")
     print(f"\nTo upgrade, run:")
     print(f"  pipx upgrade mdify-cli")
     print(f"  # or: pip install --upgrade mdify-cli\n")
@@ -146,13 +147,18 @@ def check_for_update(force: bool = False) -> None:
 # Container runtime functions
 # =============================================================================
 
-def detect_runtime(preferred: str) -> Optional[str]:
+
+def detect_runtime(preferred: str, explicit: bool = True) -> Optional[str]:
     """
     Detect available container runtime.
-    
+
     Args:
         preferred: Preferred runtime ('docker' or 'podman')
-        
+        explicit: If True, warn when falling back to alternative.
+                  If False, silently use alternative without warning.
+                  Note: This only controls warning emission; selection order
+                  is always preferred → alternative regardless of this flag.
+
     Returns:
         Path to runtime executable, or None if not found.
     """
@@ -160,25 +166,28 @@ def detect_runtime(preferred: str) -> Optional[str]:
     runtime_path = shutil.which(preferred)
     if runtime_path:
         return runtime_path
-    
+
     # Try alternative
     alternative = "podman" if preferred == "docker" else "docker"
     runtime_path = shutil.which(alternative)
     if runtime_path:
-        print(f"Warning: {preferred} not found, using {alternative}", file=sys.stderr)
+        if explicit:
+            print(
+                f"Warning: {preferred} not found, using {alternative}", file=sys.stderr
+            )
         return runtime_path
-    
+
     return None
 
 
 def check_image_exists(runtime: str, image: str) -> bool:
     """
     Check if container image exists locally.
-    
+
     Args:
         runtime: Path to container runtime
         image: Image name/tag
-        
+
     Returns:
         True if image exists locally.
     """
@@ -196,18 +205,18 @@ def check_image_exists(runtime: str, image: str) -> bool:
 def pull_image(runtime: str, image: str, quiet: bool = False) -> bool:
     """
     Pull container image.
-    
+
     Args:
         runtime: Path to container runtime
         image: Image name/tag
         quiet: Suppress progress output
-        
+
     Returns:
         True if pull succeeded.
     """
     if not quiet:
         print(f"Pulling image: {image}")
-    
+
     try:
         result = subprocess.run(
             [runtime, "pull", image],
@@ -222,9 +231,9 @@ def pull_image(runtime: str, image: str, quiet: bool = False) -> bool:
 
 def format_size(size_bytes: int) -> str:
     """Format file size in human-readable format."""
-    for unit in ['B', 'KB', 'MB', 'GB']:
+    for unit in ["B", "KB", "MB", "GB"]:
         if size_bytes < 1024:
-            return f"{size_bytes:.1f} {unit}" if unit != 'B' else f"{size_bytes} {unit}"
+            return f"{size_bytes:.1f} {unit}" if unit != "B" else f"{size_bytes} {unit}"
         size_bytes /= 1024
     return f"{size_bytes:.1f} TB"
 
@@ -244,29 +253,33 @@ def format_duration(seconds: float) -> str:
 
 class Spinner:
     """A simple spinner to show progress during long operations."""
-    
+
     def __init__(self):
-        self.frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+        self.frames = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
         self.running = False
         self.thread = None
         self.start_time = None
-    
+
     def _spin(self):
         idx = 0
         while self.running:
             elapsed = time.time() - self.start_time
             frame = self.frames[idx % len(self.frames)]
-            print(f"\r{self.prefix} {frame} ({format_duration(elapsed)})", end="", flush=True)
+            print(
+                f"\r{self.prefix} {frame} ({format_duration(elapsed)})",
+                end="",
+                flush=True,
+            )
             idx += 1
             time.sleep(0.1)
-    
+
     def start(self, prefix: str = ""):
         self.prefix = prefix
         self.running = True
         self.start_time = time.time()
         self.thread = threading.Thread(target=self._spin, daemon=True)
         self.thread.start()
-    
+
     def stop(self):
         self.running = False
         if self.thread:
@@ -284,42 +297,48 @@ def run_container(
 ) -> Tuple[bool, str, float]:
     """
     Run container to convert a single file.
-    
+
     Args:
         runtime: Path to container runtime
         image: Image name/tag
         input_file: Absolute path to input file
         output_file: Absolute path to output file
         mask_pii: Whether to mask PII in images
-        
+
     Returns:
         Tuple of (success: bool, message: str, elapsed_seconds: float)
     """
     start_time = time.time()
-    
+
     # Ensure output directory exists
     output_file.parent.mkdir(parents=True, exist_ok=True)
-    
+
     # Mount directories
     input_dir = input_file.parent
     output_dir = output_file.parent
-    
+
     # Container paths
     container_in = f"/work/in/{input_file.name}"
     container_out = f"/work/out/{output_file.name}"
-    
+
     cmd = [
-        runtime, "run", "--rm",
-        "-v", f"{input_dir}:/work/in:ro",
-        "-v", f"{output_dir}:/work/out",
+        runtime,
+        "run",
+        "--rm",
+        "-v",
+        f"{input_dir}:/work/in:ro",
+        "-v",
+        f"{output_dir}:/work/out",
         image,
-        "--in", container_in,
-        "--out", container_out,
+        "--in",
+        container_in,
+        "--out",
+        container_out,
     ]
-    
+
     if mask_pii:
         cmd.append("--mask")
-    
+
     try:
         result = subprocess.run(
             cmd,
@@ -328,13 +347,15 @@ def run_container(
             check=False,
         )
         elapsed = time.time() - start_time
-        
+
         if result.returncode == 0:
             return True, "success", elapsed
         else:
-            error_msg = result.stderr.strip() or result.stdout.strip() or "Unknown error"
+            error_msg = (
+                result.stderr.strip() or result.stdout.strip() or "Unknown error"
+            )
             return False, error_msg, elapsed
-            
+
     except OSError as e:
         elapsed = time.time() - start_time
         return False, str(e), elapsed
@@ -346,22 +367,39 @@ def run_container(
 
 # Supported file extensions (based on Docling InputFormat)
 SUPPORTED_EXTENSIONS = {
-    '.pdf', '.docx', '.pptx', '.html', '.htm',
-    '.png', '.jpg', '.jpeg', '.gif', '.bmp', '.tiff', '.tif',  # images
-    '.asciidoc', '.adoc', '.asc',  # asciidoc
-    '.md', '.markdown',  # markdown
-    '.csv', '.xlsx',  # spreadsheets
-    '.xml',  # XML formats
-    '.json',  # JSON docling
-    '.mp3', '.wav', '.m4a', '.flac',  # audio
-    '.vtt',  # subtitles
+    ".pdf",
+    ".docx",
+    ".pptx",
+    ".html",
+    ".htm",
+    ".png",
+    ".jpg",
+    ".jpeg",
+    ".gif",
+    ".bmp",
+    ".tiff",
+    ".tif",  # images
+    ".asciidoc",
+    ".adoc",
+    ".asc",  # asciidoc
+    ".md",
+    ".markdown",  # markdown
+    ".csv",
+    ".xlsx",  # spreadsheets
+    ".xml",  # XML formats
+    ".json",  # JSON docling
+    ".mp3",
+    ".wav",
+    ".m4a",
+    ".flac",  # audio
+    ".vtt",  # subtitles
 }
 
 
 def get_files_to_convert(input_path: Path, mask: str, recursive: bool) -> List[Path]:
     """Get list of files to convert based on input path and options."""
     files = []
-    
+
     if input_path.is_file():
         files.append(input_path)
     elif input_path.is_dir():
@@ -369,19 +407,19 @@ def get_files_to_convert(input_path: Path, mask: str, recursive: bool) -> List[P
             files = list(input_path.rglob(mask))
         else:
             files = list(input_path.glob(mask))
-        
+
         # Filter to only files
         files = [f for f in files if f.is_file()]
     else:
         raise FileNotFoundError(f"Input path does not exist: {input_path}")
-    
+
     # Filter out hidden files and unsupported formats
     files = [
-        f for f in files
-        if not f.name.startswith('.')
-        and f.suffix.lower() in SUPPORTED_EXTENSIONS
+        f
+        for f in files
+        if not f.name.startswith(".") and f.suffix.lower() in SUPPORTED_EXTENSIONS
     ]
-    
+
     return files
 
 
@@ -414,7 +452,7 @@ def get_output_path(
             output_path = output_dir / relative_path.parent / output_name
         except ValueError:
             output_path = output_dir / output_name
-        
+
         return output_path
 
 
@@ -422,6 +460,7 @@ def get_output_path(
 # CLI argument parsing
 # =============================================================================
 
+
 def parse_args() -> argparse.Namespace:
     """Parse command line arguments."""
     parser = argparse.ArgumentParser(
@@ -436,74 +475,79 @@ Examples:
   mdify ./docs --runtime podman          Use Podman instead of Docker
 """,
     )
-    
+
     parser.add_argument(
         "input",
         type=str,
         nargs="?",
         help="Input file or directory to convert",
     )
-    
+
     parser.add_argument(
-        "-o", "--out-dir",
+        "-o",
+        "--out-dir",
         type=str,
         default="output",
         help="Output directory for converted files (default: output)",
     )
-    
+
     parser.add_argument(
-        "-g", "--glob",
+        "-g",
+        "--glob",
         type=str,
         default="*",
         help="Glob pattern for filtering files in directory (default: *)",
     )
-    
+
     parser.add_argument(
-        "-r", "--recursive",
+        "-r",
+        "--recursive",
         action="store_true",
         help="Recursively scan directories",
     )
-    
+
     parser.add_argument(
         "--flat",
         action="store_true",
         help="Disable directory structure preservation in output",
     )
-    
+
     parser.add_argument(
         "--overwrite",
         action="store_true",
         help="Overwrite existing output files",
     )
-    
+
     parser.add_argument(
-        "-q", "--quiet",
+        "-q",
+        "--quiet",
         action="store_true",
         help="Suppress progress messages",
     )
-    
+
     parser.add_argument(
-        "-m", "--mask",
+        "-m",
+        "--mask",
         action="store_true",
         help="Mask PII and sensitive content in document images",
     )
-    
+
     # Container options
     parser.add_argument(
         "--runtime",
         type=str,
         choices=SUPPORTED_RUNTIMES,
-        default="docker",
-        help="Container runtime to use (default: docker)",
+        default=None,
+        help="Container runtime to use (auto-detects docker or podman if not specified)",
     )
-    
+
     parser.add_argument(
         "--image",
         type=str,
         default=DEFAULT_IMAGE,
         help=f"Container image to use (default: {DEFAULT_IMAGE})",
     )
-    
+
     parser.add_argument(
         "--pull",
         type=str,
@@ -511,20 +555,20 @@ Examples:
         default="missing",
         help="Image pull policy: always, missing, never (default: missing)",
     )
-    
+
     # Utility options
     parser.add_argument(
         "--check-update",
         action="store_true",
         help="Check for available updates and exit",
     )
-    
+
     parser.add_argument(
         "--version",
         action="version",
         version=f"mdify {__version__}",
     )
-    
+
     return parser.parse_args()
 
 
@@ -532,27 +576,30 @@ Examples:
 # Main entry point
 # =============================================================================
 
+
 def main() -> int:
     """Main entry point for the CLI."""
     args = parse_args()
-    
+
     # Handle --check-update flag
     if args.check_update:
         check_for_update(force=True)
         return 0
-    
+
     # Check for updates (daily, silent on errors)
     check_for_update(force=False)
-    
+
     # Validate input is provided
     if args.input is None:
         print("Error: Input file or directory is required", file=sys.stderr)
         print("Usage: mdify <input> [options]", file=sys.stderr)
         print("       mdify --help for more information", file=sys.stderr)
         return 1
-    
+
     # Detect container runtime
-    runtime = detect_runtime(args.runtime)
+    preferred = args.runtime if args.runtime else "docker"
+    explicit = args.runtime is not None
+    runtime = detect_runtime(preferred, explicit=explicit)
     if runtime is None:
         print(
             f"Error: Container runtime not found ({', '.join(SUPPORTED_RUNTIMES)})",
@@ -560,85 +607,87 @@ def main() -> int:
         )
         print("Please install Docker or Podman to use mdify.", file=sys.stderr)
         return 2
-    
+
     # Handle image pull policy
     image = args.image
     image_exists = check_image_exists(runtime, image)
-    
+
     if args.pull == "always" or (args.pull == "missing" and not image_exists):
         if not pull_image(runtime, image, args.quiet):
             print(f"Error: Failed to pull image: {image}", file=sys.stderr)
             return 1
     elif args.pull == "never" and not image_exists:
         print(f"Error: Image not found locally: {image}", file=sys.stderr)
-        print(f"Run with --pull=missing or pull manually: {args.runtime} pull {image}")
+        print(f"Run with --pull=missing or pull manually: {preferred} pull {image}")
         return 1
-    
+
     # Resolve paths
     input_path = Path(args.input).resolve()
     output_dir = Path(args.out_dir).resolve()
-    
+
     # Validate input
     if not input_path.exists():
         print(f"Error: Input path does not exist: {input_path}", file=sys.stderr)
         return 1
-    
+
     # Get files to convert
     try:
         files_to_convert = get_files_to_convert(input_path, args.glob, args.recursive)
     except Exception as e:
         print(f"Error: {e}", file=sys.stderr)
         return 1
-    
+
     if not files_to_convert:
         print(f"No files found to convert in: {input_path}", file=sys.stderr)
         return 1
-    
+
     total_files = len(files_to_convert)
     total_size = sum(f.stat().st_size for f in files_to_convert)
-    
+
     if not args.quiet:
         print(f"Found {total_files} file(s) to convert ({format_size(total_size)})")
         print(f"Using runtime: {runtime}")
         print(f"Using image: {image}")
         print()
-    
+
     # Determine input base for directory structure preservation
     if input_path.is_file():
         input_base = input_path.parent
     else:
         input_base = input_path
-    
+
     # Convert files
     success_count = 0
     skipped_count = 0
     failed_count = 0
     conversion_start = time.time()
     spinner = Spinner()
-    
+
     for idx, input_file in enumerate(files_to_convert, 1):
         output_file = get_output_path(input_file, input_base, output_dir, args.flat)
         file_size = input_file.stat().st_size
         progress = f"[{idx}/{total_files}]"
-        
+
         # Check if output exists and skip if not overwriting
         if output_file.exists() and not args.overwrite:
             if not args.quiet:
                 print(f"{progress} Skipped (exists): {input_file.name}")
             skipped_count += 1
             continue
-        
+
         # Show spinner while processing
         if not args.quiet:
-            spinner.start(f"{progress} Processing: {input_file.name} ({format_size(file_size)})")
-        
+            spinner.start(
+                f"{progress} Processing: {input_file.name} ({format_size(file_size)})"
+            )
+
         success, result, elapsed = run_container(
             runtime, image, input_file, output_file, args.mask
         )
-        
+
         if not args.quiet:
             spinner.stop()
-        
+
         if success:
             success_count += 1
             if not args.quiet:
@@ -648,9 +697,9 @@ def main() -> int:
             if not args.quiet:
                 print(f"{progress} {input_file.name} ✗ ({format_duration(elapsed)})")
                 print(f"    Error: {result}", file=sys.stderr)
-    
+
     total_elapsed = time.time() - conversion_start
-    
+
     # Print summary
     if not args.quiet:
         print()
@@ -662,7 +711,7 @@ def main() -> int:
         print(f"  Failed:          {failed_count}")
         print(f"  Total time:      {format_duration(total_elapsed)}")
         print("=" * 50)
-    
+
     # Return appropriate exit code
     if failed_count > 0:
         return 1

{mdify_cli-1.4.1.dist-info → mdify_cli-1.6.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: mdify-cli
-Version: 1.4.1
-Summary: Lightweight CLI for converting documents to Markdown via Docling container
+Version: 1.6.0
+Summary: Convert PDFs and document images into structured Markdown for LLM workflows
 Author: tiroq
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/tiroq/mdify
@@ -24,6 +24,8 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
 Dynamic: license-file
 
 # mdify
@@ -34,7 +36,7 @@ Dynamic: license-file
 [![Container](https://img.shields.io/badge/container-ghcr.io-blue?logo=docker&style=flat-square)](https://github.com/tiroq/mdify/pkgs/container/mdify-runtime)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-A lightweight CLI for converting documents to Markdown. The CLI is fast to install via pipx, while the heavy ML conversion (Docling) runs inside a container.
+A lightweight CLI for converting documents to Markdown. The CLI is fast to install via pipx, while the heavy ML conversion runs inside a container.
 
 ## Requirements
 

mdify_cli-1.6.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+assets/mdify.png,sha256=qUj7WXWqNwpI2KNXOW79XJwqFqa-UI0JEkmt1mmy4Rg,1820418
+mdify/__init__.py,sha256=tvxIF7MWdoaHBgdk4tT81csn-ZhTTOlfooBYqM4YsMg,90
+mdify/__main__.py,sha256=bhpJ00co6MfaVOdH4XLoW04NtLYDa_oJK7ODzfLrn9M,143
+mdify/cli.py,sha256=sDwkOf4H33l7WmfAR3tw2MjO-7kuIOHcrQXTZto6bF0,20460
+mdify_cli-1.6.0.dist-info/licenses/LICENSE,sha256=NWM66Uv-XuSMKaU-gaPmvfyk4WgE6zcIPr78wyg6GAo,1065
+mdify_cli-1.6.0.dist-info/METADATA,sha256=W-tubNyeCkt6_GAYmS59JHwka8FxQ4D5ZxbHDKFhaLQ,6721
+mdify_cli-1.6.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+mdify_cli-1.6.0.dist-info/entry_points.txt,sha256=0Xki8f5lADQUtwdt6Eq_FEaieI6Byhk8UE7BuDhChMg,41
+mdify_cli-1.6.0.dist-info/top_level.txt,sha256=qltzf7h8owHq7dxCdfCkSHY8gT21hn1_E8P-VWS_OKM,6
+mdify_cli-1.6.0.dist-info/RECORD,,

{mdify_cli-1.4.1.dist-info → mdify_cli-1.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mdify_cli-1.4.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-assets/mdify.png,sha256=qUj7WXWqNwpI2KNXOW79XJwqFqa-UI0JEkmt1mmy4Rg,1820418
-mdify/__init__.py,sha256=NWY-5XYsO7gQZs9c4utyzGda6anA_FDBB2LNNUIqsdo,90
-mdify/__main__.py,sha256=bhpJ00co6MfaVOdH4XLoW04NtLYDa_oJK7ODzfLrn9M,143
-mdify/cli.py,sha256=D8_1_6NgWXkexGWqkgB0JO7c1r2T2_Va7J7iGwvewQA,20038
-mdify_cli-1.4.1.dist-info/licenses/LICENSE,sha256=NWM66Uv-XuSMKaU-gaPmvfyk4WgE6zcIPr78wyg6GAo,1065
-mdify_cli-1.4.1.dist-info/METADATA,sha256=sZgTSq6CrpBgpJn0NCnLcBYNTp2e0byKeFkAOO6em3E,6667
-mdify_cli-1.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mdify_cli-1.4.1.dist-info/entry_points.txt,sha256=0Xki8f5lADQUtwdt6Eq_FEaieI6Byhk8UE7BuDhChMg,41
-mdify_cli-1.4.1.dist-info/top_level.txt,sha256=qltzf7h8owHq7dxCdfCkSHY8gT21hn1_E8P-VWS_OKM,6
-mdify_cli-1.4.1.dist-info/RECORD,,