Skip to content
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

Update README.md #28

Merged
merged 2 commits into from
Dec 15, 2024
Merged
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
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ It presently supports:
- HTML (special handling of Wikipedia, etc.)
- Various other text-based formats (csv, json, xml, etc.)

# Installation

You can install `markitdown` using pip:

```python
pip install markitdown
```

or from the source

```sh
pip install -e .
```


# Usage
The API is simple:

```python
Expand All @@ -23,12 +39,16 @@ result = markitdown.convert("test.xlsx")
print(result.text_content)
```

## Installation
You can also configure markitdown to use Large Language Models to describe images. To do so you must provide mlm_client and mlm_model parameters to MarkItDown object, according to your specific client.

MarkItDown can be installed using pip:
```python
from markitdown import MarkItDown
from openai import OpenAI

```
pip install markitdown
client = OpenAI()
md = MarkItDown(mlm_client=client, mlm_model="gpt-4o")
result = md.convert("example.jpg")
print(result.text_content)
```

## Contributing
Expand All @@ -49,9 +69,6 @@ contact [[email protected]](mailto:[email protected]) with any additio

To install the dependencies for this project, run the following command in the root of the project:

```sh
pip install -e .
```

## Running Tests

Expand Down
Loading