mdify-cli 1.2.0__tar.gz

mdify_cli-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stranger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mdify_cli-1.2.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: mdify-cli
+Version: 1.2.0
+Summary: Lightweight CLI for converting documents to Markdown via Docling container
+Author: tiroq
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tiroq/mdify
+Project-URL: Repository, https://github.com/tiroq/mdify
+Project-URL: Issues, https://github.com/tiroq/mdify/issues
+Keywords: markdown,conversion,pdf,docling,cli,document,docker
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# mdify
+
+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.
+
+## Requirements
+
+- **Python 3.8+**
+- **Docker** or **Podman** (for document conversion)
+
+## Installation
+
+### macOS (recommended)
+
+```bash
+brew install pipx
+pipx ensurepath
+pipx install mdify-cli
+```
+
+Restart your terminal after installation.
+
+### Linux
+
+```bash
+python3 -m pip install --user pipx
+pipx ensurepath
+pipx install mdify-cli
+```
+
+### Install via pip
+
+```bash
+pip install mdify-cli
+```
+
+### Development install
+
+```bash
+git clone https://github.com/tiroq/mdify.git
+cd mdify
+pip install -e .
+```
+
+## Usage
+
+### Basic conversion
+
+Convert a single file:
+```bash
+mdify document.pdf
+```
+
+The first run will automatically pull the container image (~2GB) if not present.
+
+### Convert multiple files
+
+Convert all PDFs in a directory:
+```bash
+mdify /path/to/documents -g "*.pdf"
+```
+
+Recursively convert files:
+```bash
+mdify /path/to/documents -r -g "*.pdf"
+```
+
+### Masking sensitive content
+
+Mask PII and sensitive content in images:
+```bash
+mdify document.pdf -m
+mdify document.pdf --mask
+```
+
+This uses Docling's content-aware masking to obscure sensitive information in embedded images.
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `input` | Input file or directory to convert (required) |
+| `-o, --out-dir DIR` | Output directory for converted files (default: output) |
+| `-g, --glob PATTERN` | Glob pattern for filtering files (default: *) |
+| `-r, --recursive` | Recursively scan directories |
+| `--flat` | Disable directory structure preservation |
+| `--overwrite` | Overwrite existing output files |
+| `-q, --quiet` | Suppress progress messages |
+| `-m, --mask` | Mask PII and sensitive content in images |
+| `--runtime RUNTIME` | Container runtime: docker or podman (auto-detected) |
+| `--image IMAGE` | Custom container image (default: ghcr.io/tiroq/mdify-runtime:latest) |
+| `--pull POLICY` | Image pull policy: always, missing, never (default: missing) |
+| `--check-update` | Check for available updates and exit |
+| `--version` | Show version and exit |
+
+### Flat Mode
+
+With `--flat`, all output files are placed directly in the output directory. Directory paths are incorporated into filenames to prevent collisions:
+
+- `docs/subdir1/file.pdf` → `output/subdir1_file.md`
+- `docs/subdir2/file.pdf` → `output/subdir2_file.md`
+
+## Examples
+
+Convert all PDFs recursively, preserving structure:
+```bash
+mdify documents/ -r -g "*.pdf" -o markdown_output
+```
+
+Convert with Podman instead of Docker:
+```bash
+mdify document.pdf --runtime podman
+```
+
+Use a custom/local container image:
+```bash
+mdify document.pdf --image my-custom-image:latest
+```
+
+Force pull latest container image:
+```bash
+mdify document.pdf --pull
+```
+
+## Architecture
+
+```
+┌──────────────────┐     ┌─────────────────────────────────┐
+│   mdify CLI      │     │  Container (Docker/Podman)      │
+│   (lightweight)  │────▶│  ┌───────────────────────────┐  │
+│                  │     │  │  Docling + ML Models      │  │
+│  - File handling │◀────│  │  - PDF parsing            │  │
+│  - Container     │     │  │  - OCR (Tesseract)        │  │
+│    orchestration │     │  │  - Document conversion    │  │
+└──────────────────┘     │  └───────────────────────────┘  │
+                         └─────────────────────────────────┘
+```
+
+The CLI:
+- Installs in seconds via pipx (no ML dependencies)
+- Automatically detects Docker or Podman
+- Pulls the runtime container on first use
+- Mounts files and runs conversions in the container
+
+## Container Image
+
+The runtime container is hosted at:
+```
+ghcr.io/tiroq/mdify-runtime:latest
+```
+
+To build locally:
+```bash
+cd runtime
+docker build -t mdify-runtime .
+```
+
+## Updates
+
+mdify checks for updates daily. When a new version is available:
+
+```
+==================================================
+A new version of mdify is available!
+  Current version: 0.3.0
+  Latest version:  0.4.0
+==================================================
+
+Run upgrade now? [y/N]
+```
+
+### Disable update checks
+
+```bash
+export MDIFY_NO_UPDATE_CHECK=1
+```
+
+## Uninstall
+
+```bash
+pipx uninstall mdify-cli
+```
+
+Or if installed via pip:
+
+```bash
+pip uninstall mdify-cli
+```
+
+## Development
+
+### Task automation
+
+This project uses [Task](https://taskfile.dev) for automation:
+
+```bash
+# Show available tasks
+task
+
+# Build package
+task build
+
+# Build container locally
+task container-build
+
+# Release workflow
+task release-patch
+```
+
+### Building for PyPI
+
+See [PUBLISHING.md](PUBLISHING.md) for complete publishing instructions.
+
+## License
+
+MIT

mdify_cli-1.2.0/README.md

@@ -0,0 +1,215 @@
+# mdify
+
+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.
+
+## Requirements
+
+- **Python 3.8+**
+- **Docker** or **Podman** (for document conversion)
+
+## Installation
+
+### macOS (recommended)
+
+```bash
+brew install pipx
+pipx ensurepath
+pipx install mdify-cli
+```
+
+Restart your terminal after installation.
+
+### Linux
+
+```bash
+python3 -m pip install --user pipx
+pipx ensurepath
+pipx install mdify-cli
+```
+
+### Install via pip
+
+```bash
+pip install mdify-cli
+```
+
+### Development install
+
+```bash
+git clone https://github.com/tiroq/mdify.git
+cd mdify
+pip install -e .
+```
+
+## Usage
+
+### Basic conversion
+
+Convert a single file:
+```bash
+mdify document.pdf
+```
+
+The first run will automatically pull the container image (~2GB) if not present.
+
+### Convert multiple files
+
+Convert all PDFs in a directory:
+```bash
+mdify /path/to/documents -g "*.pdf"
+```
+
+Recursively convert files:
+```bash
+mdify /path/to/documents -r -g "*.pdf"
+```
+
+### Masking sensitive content
+
+Mask PII and sensitive content in images:
+```bash
+mdify document.pdf -m
+mdify document.pdf --mask
+```
+
+This uses Docling's content-aware masking to obscure sensitive information in embedded images.
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `input` | Input file or directory to convert (required) |
+| `-o, --out-dir DIR` | Output directory for converted files (default: output) |
+| `-g, --glob PATTERN` | Glob pattern for filtering files (default: *) |
+| `-r, --recursive` | Recursively scan directories |
+| `--flat` | Disable directory structure preservation |
+| `--overwrite` | Overwrite existing output files |
+| `-q, --quiet` | Suppress progress messages |
+| `-m, --mask` | Mask PII and sensitive content in images |
+| `--runtime RUNTIME` | Container runtime: docker or podman (auto-detected) |
+| `--image IMAGE` | Custom container image (default: ghcr.io/tiroq/mdify-runtime:latest) |
+| `--pull POLICY` | Image pull policy: always, missing, never (default: missing) |
+| `--check-update` | Check for available updates and exit |
+| `--version` | Show version and exit |
+
+### Flat Mode
+
+With `--flat`, all output files are placed directly in the output directory. Directory paths are incorporated into filenames to prevent collisions:
+
+- `docs/subdir1/file.pdf` → `output/subdir1_file.md`
+- `docs/subdir2/file.pdf` → `output/subdir2_file.md`
+
+## Examples
+
+Convert all PDFs recursively, preserving structure:
+```bash
+mdify documents/ -r -g "*.pdf" -o markdown_output
+```
+
+Convert with Podman instead of Docker:
+```bash
+mdify document.pdf --runtime podman
+```
+
+Use a custom/local container image:
+```bash
+mdify document.pdf --image my-custom-image:latest
+```
+
+Force pull latest container image:
+```bash
+mdify document.pdf --pull
+```
+
+## Architecture
+
+```
+┌──────────────────┐     ┌─────────────────────────────────┐
+│   mdify CLI      │     │  Container (Docker/Podman)      │
+│   (lightweight)  │────▶│  ┌───────────────────────────┐  │
+│                  │     │  │  Docling + ML Models      │  │
+│  - File handling │◀────│  │  - PDF parsing            │  │
+│  - Container     │     │  │  - OCR (Tesseract)        │  │
+│    orchestration │     │  │  - Document conversion    │  │
+└──────────────────┘     │  └───────────────────────────┘  │
+                         └─────────────────────────────────┘
+```
+
+The CLI:
+- Installs in seconds via pipx (no ML dependencies)
+- Automatically detects Docker or Podman
+- Pulls the runtime container on first use
+- Mounts files and runs conversions in the container
+
+## Container Image
+
+The runtime container is hosted at:
+```
+ghcr.io/tiroq/mdify-runtime:latest
+```
+
+To build locally:
+```bash
+cd runtime
+docker build -t mdify-runtime .
+```
+
+## Updates
+
+mdify checks for updates daily. When a new version is available:
+
+```
+==================================================
+A new version of mdify is available!
+  Current version: 0.3.0
+  Latest version:  0.4.0
+==================================================
+
+Run upgrade now? [y/N]
+```
+
+### Disable update checks
+
+```bash
+export MDIFY_NO_UPDATE_CHECK=1
+```
+
+## Uninstall
+
+```bash
+pipx uninstall mdify-cli
+```
+
+Or if installed via pip:
+
+```bash
+pip uninstall mdify-cli
+```
+
+## Development
+
+### Task automation
+
+This project uses [Task](https://taskfile.dev) for automation:
+
+```bash
+# Show available tasks
+task
+
+# Build package
+task build
+
+# Build container locally
+task container-build
+
+# Release workflow
+task release-patch
+```
+
+### Building for PyPI
+
+See [PUBLISHING.md](PUBLISHING.md) for complete publishing instructions.
+
+## License
+
+MIT

mdify_cli-1.2.0/mdify/__init__.py

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

mdify_cli-1.2.0/mdify/__main__.py

@@ -0,0 +1,7 @@
+"""Allow running mdify as a module: python -m mdify"""
+
+import sys
+from mdify.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())