mistral-ai-ocr 1.0__py3-none-any.whl → 1.1__py3-none-any.whl

{mistral_ai_ocr-1.0.dist-info → mistral_ai_ocr-1.1.dist-info}/METADATA

@@ -1,12 +1,48 @@
 Metadata-Version: 2.1
 Name: mistral-ai-ocr
-Version: 1.0
+Version: 1.1
 Description-Content-Type: text/markdown
 Requires-Dist: mistralai
 Requires-Dist: python-dotenv
 
 # Mistral AI OCR
-This is a simple script that uses the Mistral AI OCR API to extract text from a PDF or image file
+This is a simple script that uses the Mistral AI OCR API to get the Markdown text from a PDF or image file
+
+# Usage
+
+## Install the Requirements
+
+To install the necessary requirements, run the following command:
+
+```sh
+pip install mistral-ai-ocr
+```
+
+## Typical Usage
+
+```sh
+mistral-ai-ocr paper.pdf
+mistral-ai-ocr paper.pdf --api-key jrWjJE5lFketfB2sA6vvhQK2SoHQ6R39
+mistral-ai-ocr paper.pdf -o revision
+mistral-ai-ocr paper.pdf -e
+mistral-ai-ocr paper.pdf -m FULL
+mistral-ai-ocr page74.jpg -e
+mistral-ai-ocr -j paper.json
+mistral-ai-ocr -j paper.json -m TEXT_NO_PAGES -n
+```
+
+## Arguments
+
+| Argument || Description |
+|-|-|-|
+| | | input PDF or image file |
+| -k API_KEY | --api-key API_KEY | Mistral API key, can be set via the **MISTRAL_API_KEY** environment variable |
+| -o OUTPUT | --output OUTPUT | output directory path. If not set, a directory will be created in the current working directory using the same stem (filename without extension) as the input file |
+| -j JSON_OCR_RESPONSE | --json-ocr-response JSON_OCR_RESPONSE | path from which to load a pre-existing JSON OCR response (any input file will be ignored) |
+| -m MODE | --mode MODE | mode of operation: either the name or numerical value of the mode. _Defaults to FULL_NO_PAGES_ |
+| -s PAGE_SEPARATOR | --page-separator PAGE_SEPARATOR | page separator to use when writing the Markdown file. _Defaults to `\n`_ |
+| -n | --no-json | do not write the JSON OCR response to a file. By default, the response is written |
+| -e | --load-dot-env | load the .env file from the current directory using [`python-dotenv`](https://pypi.org/project/python-dotenv/), to retrieve the Mistral API key |
 
 ## Modes
 
@@ -108,42 +144,6 @@ paper
 
 By default, the JSON response from the Mistral AI OCR API is saved in the output directory. To disable JSON output, use the `-n` or `--no-json` argument. To experiment with a different **mode** without using additional API calls, reuse an existing JSON response instead of the original input file
 
-# Usage
-
-## Install the Requirements
-
-To install the necessary requirements, run the following command:
-
-```sh
-pip install mistral-ai-ocr
-```
-
-## Typical Usage
-
-```sh
-mistral-ai-ocr paper.pdf
-mistral-ai-ocr paper.pdf --api-key jrWjJE5lFketfB2sA6vvhQK2SoHQ6R39
-mistral-ai-ocr paper.pdf -o revision
-mistral-ai-ocr paper.pdf -e
-mistral-ai-ocr paper.pdf -m FULL
-mistral-ai-ocr page74.jpg -e
-mistral-ai-ocr -j paper.json
-mistral-ai-ocr -j paper.json -m TEXT_NO_PAGES -n
-```
-
-## Arguments
-
-| Argument || Description |
-|-|-|-|
-| | | input PDF or image file |
-| -k API_KEY | --api-key API_KEY | Mistral API key, can be set via the **MISTRAL_API_KEY** environment variable |
-| -o OUTPUT | --output OUTPUT | output directory path. If not set, a directory will be created in the current working directory using the same stem (filename without extension) as the input file |
-| -j JSON_OCR_RESPONSE | --json-ocr-response JSON_OCR_RESPONSE | path from which to load a pre-existing JSON OCR response (any input file will be ignored) |
-| -m MODE | --mode MODE | mode of operation: either the name or numerical value of the mode. _Defaults to FULL_NO_PAGES_ |
-| -s PAGE_SEPARATOR | --page-separator PAGE_SEPARATOR | page separator to use when writing the Markdown file. _Defaults to `\n`_ |
-| -n | --no-json | do not write the JSON OCR response to a file. By default, the response is written |
-| -e | --load-dot-env | load the .env file from the current directory using [`python-dotenv`](https://pypi.org/project/python-dotenv/), to retrieve the Mistral API key |
-
 ### Mistral AI API Key
 
 To obtain an API key, you need a [Mistral AI](https://auth.mistral.ai/ui/registration) account. Then visit [https://admin.mistral.ai/organization/api-keys](https://admin.mistral.ai/organization/api-keys) and click the **Create new key** button

mistral_ai_ocr-1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+mistral_ai_ocr/__init__.py,sha256=wOwicDbjQMcMWubEnPogXRyAiV6JVrJhiXZmWRkPsVw,9248
+mistral_ai_ocr/__main__.py,sha256=5Jrno0r448BT2HdNrXLi2H6RLkUqP76IV4kmB3HuJ6g,3247
+mistral_ai_ocr-1.1.dist-info/METADATA,sha256=lxFIzL-zbSIqM-_IUVRuhniCmWzM6PwlPACeKbkdVmk,4410
+mistral_ai_ocr-1.1.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+mistral_ai_ocr-1.1.dist-info/entry_points.txt,sha256=m-ENd87vam6706-mmfzVfBq5q028TKM-7SMLUakWd-U,64
+mistral_ai_ocr-1.1.dist-info/top_level.txt,sha256=4X0WShtu4WEMtVriRP9X2Fia0ORjbAK03bRYimMvRHA,15
+mistral_ai_ocr-1.1.dist-info/RECORD,,

mistral_ai_ocr-1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-mistral_ai_ocr/__init__.py,sha256=wOwicDbjQMcMWubEnPogXRyAiV6JVrJhiXZmWRkPsVw,9248
-mistral_ai_ocr/__main__.py,sha256=5Jrno0r448BT2HdNrXLi2H6RLkUqP76IV4kmB3HuJ6g,3247
-mistral_ai_ocr-1.0.dist-info/METADATA,sha256=hqq21JC0r4mFIy0vY7UYm9R_Mbcr4ebgYawnyGNiPyo,4401
-mistral_ai_ocr-1.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-mistral_ai_ocr-1.0.dist-info/entry_points.txt,sha256=m-ENd87vam6706-mmfzVfBq5q028TKM-7SMLUakWd-U,64
-mistral_ai_ocr-1.0.dist-info/top_level.txt,sha256=4X0WShtu4WEMtVriRP9X2Fia0ORjbAK03bRYimMvRHA,15
-mistral_ai_ocr-1.0.dist-info/RECORD,,