Skip to content

Added Python MarkItDown docs #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@
"group": "Python guides",
"pages": [
"guides/python/python-image-processing",
"guides/python/python-doc-to-markdown",
"guides/python/python-crawl4ai",
"guides/python/python-pdf-form-extractor"
]
Expand Down
1 change: 1 addition & 0 deletions docs/guides/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Get set up fast using our detailed walk-through guides.
| [Cursor rules](/guides/cursor-rules) | Use Cursor rules to help write Trigger.dev tasks |
| [Prisma](/guides/frameworks/prisma) | How to setup Prisma with Trigger.dev |
| [Python image processing](/guides/python/python-image-processing) | Use Python and Pillow to process images |
| [Python document to markdown](/guides/python/python-doc-to-markdown) | Use Python and MarkItDown to convert documents to markdown |
| [Python PDF form extractor](/guides/python/python-pdf-form-extractor) | Use Python, PyMuPDF and Trigger.dev to extract data from a PDF form |
| [Python web crawler](/guides/python/python-crawl4ai) | Use Python, Crawl4AI and Playwright to create a headless web crawler |
| [Sequin database triggers](/guides/frameworks/sequin) | Trigger tasks from database changes using Sequin |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/python/python-crawl4ai.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Python headless browser web crawler example"
sidebarTitle: "Python headless web crawler"
sidebarTitle: "Headless web crawler"
description: "Learn how to use Python, Crawl4AI and Playwright to create a headless browser web crawler with Trigger.dev."
---

Expand Down
224 changes: 224 additions & 0 deletions docs/guides/python/python-doc-to-markdown.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
---
title: "Convert documents to markdown using Python and MarkItDown"
sidebarTitle: "Convert docs to markdown"
description: "Learn how to use Trigger.dev with Python to convert documents to markdown using MarkItDown."
---

import PythonLearnMore from "/snippets/python-learn-more.mdx";

<Note>
This project uses Trigger.dev v4 (which is currently in beta as of 28 April 2025). If you want to
run this project you will need to [upgrade to v4](/upgrade-to-v4).
</Note>
Comment on lines +9 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Broken “upgrade to v4” link in Note.
The callout points at /upgrade-to-v4, but our v4 upgrade guide lives under /docs/guides/upgrade-to-v4 (or similar). Update the link to the correct path to prevent a 404 in the docs.


## Overview

Convert documents to markdown using Microsoft's [MarkItDown](https://github.com/microsoft/markitdown) library. This can be especially useful for preparing documents in a structured format for AI applications.

## Prerequisites

- A project with [Trigger.dev initialized](/quick-start)
- [Python](https://www.python.org/) installed on your local machine. _This example requires Python 3.10 or higher._

## Features

- A Trigger.dev task which downloads a document from a URL and runs the Python script which converts it to markdown
- A Python script to convert documents to markdown using Microsoft's [MarkItDown](https://github.com/microsoft/markitdown) library
- Uses our [Python build extension](/config/extensions/pythonExtension) to install dependencies and run Python scripts

## GitHub repo

<Card
title="View the project on GitHub"
icon="GitHub"
href="https://github.com/triggerdotdev/examples/tree/main/python-doc-to-markdown-converter"
>
Click here to view the full code for this project in our examples repository on GitHub. You can
fork it and use it as a starting point for your own project.
</Card>

## The code

### Build configuration

After you've initialized your project with Trigger.dev, add these build settings to your `trigger.config.ts` file:

```ts trigger.config.ts
import { pythonExtension } from "@trigger.dev/python/extension";
import { defineConfig } from "@trigger.dev/sdk/v3";

export default defineConfig({
runtime: "node",
project: "<your-project-ref>",
// Your other config settings...
build: {
extensions: [
pythonExtension({
// The path to your requirements.txt file
requirementsFile: "./requirements.txt",
// The path to your Python binary
devPythonBinaryPath: `venv/bin/python`,
// The paths to your Python scripts to run
scripts: ["src/python/**/*.py"],
}),
],
},
});
```
Comment on lines +46 to +67
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Inconsistent SDK version vs. Note v4 reference.
The guide introduction mentions Trigger.dev v4 (beta), but this snippet imports from @trigger.dev/sdk/v3. Please either:

  • Update the snippet to use the v4 SDK package (e.g., @trigger.dev/sdk/v4),
  • Or adjust the Note to indicate that this example targets v3.
    Aligning versions avoids confusion.


<Info>
Learn more about executing scripts in your Trigger.dev project using our Python build extension
[here](/config/extensions/pythonExtension).
</Info>

### Task code

This task uses the `python.runScript` method to run the `markdown-converter.py` script with the given document URL as an argument.

```ts src/trigger/convertToMarkdown.ts
import { task } from "@trigger.dev/sdk/v3";
import { python } from "@trigger.dev/python";
import * as fs from "fs";
import * as path from "path";
import * as os from "os";

export const convertToMarkdown = task({
id: "convert-to-markdown",
run: async (payload: { url: string }) => {
const { url } = payload;

// STEP 1: Create temporary file with unique name
const tempDir = os.tmpdir();
const fileName = `doc-${Date.now()}-${Math.random().toString(36).substring(2, 7)}`;
const urlPath = new URL(url).pathname;
const extension = path.extname(urlPath) || ".docx";
const tempFilePath = path.join(tempDir, `${fileName}${extension}`);

// STEP 2: Download file from URL
const response = await fetch(url);
const buffer = await response.arrayBuffer();
await fs.promises.writeFile(tempFilePath, Buffer.from(buffer));

// STEP 3: Run Python script to convert document to markdown
const pythonResult = await python.runScript("./src/python/markdown-converter.py", [
JSON.stringify({ file_path: tempFilePath }),
]);

// STEP 4: Clean up temporary file
fs.unlink(tempFilePath, () => {});

// STEP 5: Process result
if (pythonResult.stdout) {
const result = JSON.parse(pythonResult.stdout);
return {
url,
markdown: result.status === "success" ? result.markdown : null,
error: result.status === "error" ? result.error : null,
success: result.status === "success",
};
}

return {
url,
markdown: null,
error: "No output from Python script",
success: false,
};
},
});
```

### Add a requirements.txt file

Add the following to your `requirements.txt` file. This is required in Python projects to install the dependencies.

```txt requirements.txt
markitdown[all]
```

### The Python script

The Python script uses MarkItDown to convert documents to Markdown format.

```python src/python/markdown-converter.py
import json
import sys
import os
from markitdown import MarkItDown

def convert_to_markdown(file_path):
"""Convert a file to markdown format using MarkItDown"""
# Check if file exists
if not os.path.exists(file_path):
raise FileNotFoundError(f"File not found: {file_path}")

# Initialize MarkItDown
md = MarkItDown()

# Convert the file
try:
result = md.convert(file_path)
return result.text_content
except Exception as e:
raise Exception(f"Error converting file: {str(e)}")

def process_trigger_task(file_path):
"""Process a file and convert to markdown"""
try:
markdown_result = convert_to_markdown(file_path)
return {
"status": "success",
"markdown": markdown_result
}
except Exception as e:
return {
"status": "error",
"error": str(e)
}

if __name__ == "__main__":
# Get the file path from command line arguments
if len(sys.argv) < 2:
print(json.dumps({"status": "error", "error": "No file path provided"}))
sys.exit(1)

try:
config = json.loads(sys.argv[1])
file_path = config.get("file_path")

if not file_path:
print(json.dumps({"status": "error", "error": "No file path specified in config"}))
sys.exit(1)

result = process_trigger_task(file_path)
print(json.dumps(result))
except Exception as e:
print(json.dumps({"status": "error", "error": str(e)}))
sys.exit(1)
```

## Testing your task

1. Create a virtual environment `python -m venv venv`
2. Activate the virtual environment, depending on your OS: On Mac/Linux: `source venv/bin/activate`, on Windows: `venv\Scripts\activate`
3. Install the Python dependencies `pip install -r requirements.txt`. _Make sure you have Python 3.10 or higher installed._
4. Copy the project ref from your [Trigger.dev dashboard](https://cloud.trigger.dev) and add it to the `trigger.config.ts` file.
5. Run the Trigger.dev CLI `dev` command (it may ask you to authorize the CLI if you haven't already).
6. Test the task in the dashboard by providing a valid document URL.
7. Deploy the task to production using the Trigger.dev CLI `deploy` command.

## MarkItDown Conversion Capabilities

- Convert various file formats to Markdown:
- Office formats (Word, PowerPoint, Excel)
- PDFs
- Images (with optional LLM-generated descriptions)
- HTML, CSV, JSON, XML
- Audio files (with optional transcription)
- ZIP archives
- And more
- Preserve document structure (headings, lists, tables, etc.)
- Handle multiple input methods (file paths, URLs, base64 data)
- Optional Azure Document Intelligence integration for better PDF and image conversion

<PythonLearnMore />
2 changes: 1 addition & 1 deletion docs/guides/python/python-image-processing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Python image processing example"
sidebarTitle: "Python image processing"
sidebarTitle: "Process images"
description: "Learn how to use Trigger.dev with Python to process images from URLs and upload them to S3."
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/python/python-pdf-form-extractor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Python PDF form extractor example"
sidebarTitle: "Python PDF form extractor"
sidebarTitle: "Extract form data from PDFs"
description: "Learn how to use Trigger.dev with Python to extract form data from PDF files."
---

Expand Down