Merge branch 'main' into fix/xlsx-sheetview-showzeroes

Author: afourney

.github/dependabot.yml

@@ -4,3 +4,5 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 7

.github/workflows/pre-commit.yml

@@ -5,9 +5,9 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: "3.x"
 

.github/workflows/tests.yml

@@ -5,8 +5,8 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: |
             3.10

README.md

@@ -20,7 +20,7 @@ MarkItDown currently supports the conversion from:
 - HTML
 - Text-based formats (CSV, JSON, XML)
 - ZIP files (iterates over contents)
-- Youtube URLs
+- YouTube URLs
 - EPubs
 - ... and more!
 
@@ -188,6 +188,13 @@ Content Understanding is ideal when you need capabilities beyond what built-in o
 markitdown path-to-file.pdf --use-cu --cu-endpoint "<content_understanding_endpoint>"
 ```
 
+The endpoint can also be set once in the environment, so callers only need `--use-cu`:
+
+```bash
+export MARKITDOWN_CU_ENDPOINT="<content_understanding_endpoint>"
+markitdown path-to-file.pdf --use-cu
+```
+
 **Python API:**
 
 ```python
@@ -244,6 +251,13 @@ To use Microsoft Document Intelligence for conversion:
 markitdown path-to-file.pdf -o document.md -d -e "<document_intelligence_endpoint>"
 ```
 
+The endpoint can also be set once in the environment, so callers only need `-d`:
+
+```bash
+export MARKITDOWN_DOCINTEL_ENDPOINT="<document_intelligence_endpoint>"
+markitdown path-to-file.pdf -o document.md -d
+```
+
 More information about how to set up an Azure Document Intelligence Resource can be found [here](https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/how-to-guides/create-document-intelligence-resource?view=doc-intel-4.0.0)
 
 ### Python API
@@ -341,9 +355,9 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc
 
 ### Security Considerations
 
-MarkItDown performs I/O with the privileges of the current process. Like `open()` or `requests.get()`, it will access resources that the process itself can access. 
+MarkItDown performs I/O with the privileges of the current process. Like `open()` or `requests.get()`, it will access resources that the process itself can access.
 
-**Sanitize your inputs:** Do not pass untrusted input directly to MarkItDown. If any part of the input may be controlled by an untrusted user or system, such as in hosted or server-side applications, it must be validated and restricted before calling MarkItDown. Depending on your environment, this may include restricting file paths, limiting URI schemes and network destinations, and blocking access to private, loopback, link-local, or metadata-service addresses. 
+**Sanitize your inputs:** Do not pass untrusted input directly to MarkItDown. If any part of the input may be controlled by an untrusted user or system, such as in hosted or server-side applications, it must be validated and restricted before calling MarkItDown. Depending on your environment, this may include restricting file paths, limiting URI schemes and network destinations, and blocking access to private, loopback, link-local, or metadata-service addresses.
 
 **Call only the conversion method you need:** Prefer the narrowest conversion API that fits your use case. MarkItDown's `convert()` method is intentionally permissive and can handle local files, remote URIs, and byte streams. If your application only needs to read local files, call `convert_local()` instead. If you need more control over URI fetching, call `requests.get()` yourself and pass the response object to `convert_response()`. For maximum control, open a stream to the input you want converted and call `convert_stream()`.
 

packages/markitdown-mcp/README.md

@@ -25,13 +25,13 @@ pip install markitdown-mcp
 To run the MCP server, using STDIO (default), use the following command:
 
 
-```bash	
+```bash
 markitdown-mcp
 ```
 
 To run the MCP server, using Streamable HTTP and SSE, use the following command:
 
-```bash	
+```bash
 markitdown-mcp --http --host 127.0.0.1 --port 3001
 ```
 
@@ -86,12 +86,12 @@ If you want to mount a directory, adjust it accordingly:
     "markitdown": {
       "command": "docker",
       "args": [
-	"run",
-	"--rm",
-	"-i",
-	"-v",
-	"/home/user/data:/workdir",
-	"markitdown-mcp:latest"
+        "run",
+        "--rm",
+        "-i",
+        "-v",
+        "/home/user/data:/workdir",
+        "markitdown-mcp:latest"
       ]
     }
   }

packages/markitdown-sample-plugin/README.md

@@ -7,16 +7,16 @@
 
 This project shows how to create a sample plugin for MarkItDown. The most important parts are as follows:
 
-Next, implement your custom DocumentConverter:
+First, implement your custom DocumentConverter:
 
 ```python
 from typing import BinaryIO, Any
-from markitdown import MarkItDown, DocumentConverter, DocumentConverterResult, StreamInfo
+from markitdown import MarkItDown, DocumentConverter, DocumentConverterResult, StreamInfo, PRIORITY_SPECIFIC_FILE_FORMAT
 
 class RtfConverter(DocumentConverter):
 
     def __init__(
-        self, priority: float = DocumentConverter.PRIORITY_SPECIFIC_FILE_FORMAT
+        self, priority: float = PRIORITY_SPECIFIC_FILE_FORMAT
     ):
         super().__init__(priority=priority)
 
@@ -26,10 +26,10 @@ class RtfConverter(DocumentConverter):
         stream_info: StreamInfo,
         **kwargs: Any,
     ) -> bool:
-	
-	# Implement logic to check if the file stream is an RTF file
-	# ...
-	raise NotImplementedError()
+
+        # Implement logic to check if the file stream is an RTF file
+        # ...
+        raise NotImplementedError()
 
 
     def convert(
@@ -39,17 +39,17 @@ class RtfConverter(DocumentConverter):
         **kwargs: Any,
     ) -> DocumentConverterResult:
 
-	# Implement logic to convert the file stream to Markdown
-	# ...
-	raise NotImplementedError()
+        # Implement logic to convert the file stream to Markdown
+        # ...
+        raise NotImplementedError()
 ```
 
 Next, make sure your package implements and exports the following:
 
 ```python
-# The version of the plugin interface that this plugin uses. 
+# The version of the plugin interface that this plugin uses.
 # The only supported version is 1 for now.
-__plugin_interface_version__ = 1 
+__plugin_interface_version__ = 1
 
 # The main entrypoint for the plugin. This is called each time MarkItDown instances are created.
 def register_converters(markitdown: MarkItDown, **kwargs):
@@ -97,7 +97,7 @@ In Python, plugins can be enabled as follows:
 ```python
 from markitdown import MarkItDown
 
-md = MarkItDown(enable_plugins=True) 
+md = MarkItDown(enable_plugins=True)
 result = md.convert("path-to-file.rtf")
 print(result.text_content)
 ```

packages/markitdown-sample-plugin/src/markitdown_sample_plugin/_plugin.py

@@ -33,7 +33,7 @@ def register_converters(markitdown: MarkItDown, **kwargs):
 
 class RtfConverter(DocumentConverter):
     """
-    Converts an RTF file to in the simplest possible way.
+    Converts an RTF file in the simplest possible way.
     """
 
     def accepts(
@@ -60,7 +60,7 @@ def convert(
         stream_info: StreamInfo,
         **kwargs: Any,
     ) -> DocumentConverterResult:
-        # Read the file stream into an str using hte provided charset encoding, or using the system default
+        # Read the file stream into a str using the provided charset encoding, or using the system default
         encoding = stream_info.charset or locale.getpreferredencoding()
         stream_data = file_stream.read().decode(encoding)
 

packages/markitdown-sample-plugin/tests/test_sample_plugin.py

@@ -13,7 +13,7 @@
 
 
 def test_converter() -> None:
-    """Tests the RTF converter dirctly."""
+    """Tests the RTF converter directly."""
     with open(os.path.join(TEST_FILES_DIR, "test.rtf"), "rb") as file_stream:
         converter = RtfConverter()
         result = converter.convert(

packages/markitdown/README.md

@@ -1,7 +1,7 @@
 # MarkItDown
 
 > [!TIP]
-> MarkItDown is a Python package and command-line utility for converting various files to Markdown (e.g., for indexing, text analysis, etc). 
+> MarkItDown is a Python package and command-line utility for converting various files to Markdown (e.g., for indexing, text analysis, etc).
 >
 > For more information, and full documentation, see the project [README.md](https://github.com/microsoft/markitdown) on GitHub.
 
@@ -13,15 +13,15 @@
 From PyPI:
 
 ```bash
-pip install markitdown[all]
+pip install 'markitdown[all]'
 ```
 
 From source:
 
 ```bash
 git clone git@github.com:microsoft/markitdown.git
 cd markitdown
-pip install -e packages/markitdown[all]
+pip install -e 'packages/markitdown[all]'
 ```
 
 ## Usage

packages/markitdown/src/markitdown/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Adam Fourney <adamfo@microsoft.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.1.6"
+__version__ = "0.1.7"