You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Openize.MarkItDown is a Python package that converts documents into Markdown format. It supports multiple file formats, provides flexible output handling, and integrates with LLMs for extended processing.
4
8
5
9
## Features
6
10
7
11
- Convert `.docx`, `.pdf`, `.xlsx`, and `.pptx` to Markdown.
8
-
- Save Markdown files locally or insert them into an LLM.
12
+
- Save Markdown files locally or send them to an LLM for processing.
9
13
- Structured with the **Factory & Strategy Pattern** for scalability.
10
-
- Works on Windows and Linux-compatible paths.
14
+
- Works with Windows and Linux-compatible paths.
15
+
- Command-line interface for easy use.
16
+
17
+
## Requirements
18
+
19
+
This package depends on the Aspose libraries, which are commercial products:
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.
-`OPENAI_API_KEY`: Required when using the `insert_into_llm=True` option or the `--llm` flag.
79
+
80
+
## Running Tests
52
81
53
82
```sh
83
+
# Install test dependencies
84
+
pip install pytest pytest-mock
85
+
86
+
# Run the tests
54
87
pytest
55
88
```
89
+
56
90
## Contributing
57
91
58
92
We appreciate your interest in contributing to this project! To ensure a smooth collaboration, please follow these steps when submitting a pull request:
@@ -63,12 +97,10 @@ We appreciate your interest in contributing to this project! To ensure a smooth
63
97
4.**Submit a Pull Request (PR)** – Once your changes are ready, open a PR with a clear description.
64
98
5.**Review & Feedback** – Our maintainers will review your PR and provide feedback if needed.
65
99
66
-
By contributing, you agree to the terms of the CLA and confirm that your changes comply with the project’s licensing policies.
67
-
68
-
We appreciate your contributions and look forward to working with you!
100
+
By contributing, you agree to the terms of the CLA and confirm that your changes comply with the project's licensing policies.
69
101
70
102
## License
71
103
72
-
This wrapper is licensed under the MIT License. However, it depends on [CommercialLibrary](https://purchase.aspose.com/pricing/), which is a proprietary, closed-source library.
104
+
This package is licensed under the MIT License. However, it depends on Aspose libraries, which are proprietary, closed-source libraries.
73
105
74
-
⚠️ Users must obtain a valid license for [CommercialLibrary](https://purchase.aspose.com/pricing/) separately. This repository does not include or distribute any proprietary components.
106
+
⚠️ Users must obtain a valid license for Aspose libraries separately. This repository does not include or distribute any proprietary components.
0 commit comments