Openize.MarkItDown for Python

Openize.MarkItDown for Python is a package that converts documents into Markdown format. It supports multiple file formats, provides flexible output handling, and integrates with LLMs for extended processing.

Features

• Convert .docx, .pdf, .xlsx, and .pptx to Markdown.
• Save Markdown files locally or send them to an LLM for processing.
• Structured with the Factory & Strategy Pattern for scalability.
• Works with Windows and Linux-compatible paths.
• Command-line interface for easy use.

Requirements

This package depends on the Aspose libraries, which are commercial products:

• Aspose.Words
• Aspose.Cells
• Aspose.Slides

You'll need to obtain valid licenses for these libraries separately. The package will install these dependencies, but you're responsible for complying with Aspose's licensing terms.

Installation

From TestPyPI

pip install openize-markitdown-python

From Source

git clone https://github.com/openize-com/openize-markitdown-python.git
cd openize-markitdown-python\packages\markitdown
pip install -e . --verbose

Usage

Command Line Interface

# Convert a file and save locally
markitdown document.docx -o output_folder

# Process with an LLM (requires OPENAI_API_KEY environment variable)
markitdown document.docx -o output_folder --insert_into_llm

Python API

from openize.markitdown.core import MarkItDown

# Define input file and output directory
input_file = "report.pdf"
output_dir = "output_markdown"

# Create MarkItDown instance
converter = MarkItDown(output_dir)

# Convert document and send output to LLM
converter.convert_document(input_file, insert_into_llm=True)

print("Conversion completed and data sent to LLM.")

Environment Variables

• ASPOSE_LICENSE_PATH: Required when using the Aspose Paid APIs. This should be set to the full path of your Aspose license file.
• OPENAI_API_KEY: Required when using the insert_into_llm=True option or the --llm flag.
• OPENAI_MODEL: Specifies the OpenAI model name (default: gpt-4).

To set these variables:

For Unix-based systems:

export ASPOSE_LICENSE_PATH="/path/to/license"
export OPENAI_API_KEY="your-api-key"
export OPENAI_MODEL="gpt-4"

For Windows (PowerShell):

$env:ASPOSE_LICENSE_PATH = "C:\path\to\license"
$env:OPENAI_API_KEY = "your-api-key"
$env:OPENAI_MODEL = "gpt-4"

Contributing

We appreciate your interest in contributing to this project! To ensure a smooth collaboration, please follow these steps when submitting a pull request:

1. Fork & Clone – Fork the repository and clone it to your local machine.
2. Create a Branch – Use a new branch for your contribution.
3. Sign the Contributor License Agreement (CLA) – Before your first contribution can be accepted, you must sign our CLA via CLA Assistant. You will be prompted to sign it when submitting your first pull request. You can also review the CLA here: https://cla.openize.com/agreement.
4. Submit a Pull Request (PR) – Once your changes are ready, open a PR with a clear description.
5. Review & Feedback – Our maintainers will review your PR and provide feedback if needed.

By contributing, you agree to the terms of the CLA and confirm that your changes comply with the project's licensing policies.

License

This package is licensed under the MIT License. However, it depends on Aspose libraries, which are proprietary, closed-source libraries.

⚠️ Users must obtain a valid license for Aspose libraries separately. This repository does not include or distribute any proprietary components.