opendataloader-pdf 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

{opendataloader_pdf-1.1.1.dist-info → opendataloader_pdf-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opendataloader-pdf
-Version: 1.1.1
+Version: 1.1.3
 Summary: A Python wrapper for the opendataloader-pdf Java CLI.
 Home-page: https://github.com/opendataloader-project/opendataloader-pdf
 Author: opendataloader-project
@@ -152,22 +152,18 @@ npm install @opendataloader/pdf
 
 ### Usage
 
-- `inputPath` can be either the path to a single document or the path to a folder.
-- If you don’t specify an `outputFolder`, the output data will be saved in the same directory as the input document.
+`inputPath` can be either the path to a single document or the path to a folder.
 
 ```typescript
-import { run } from '@opendataloader/pdf';
+import { convert } from '@opendataloader/pdf';
 
 async function main() {
   try {
-    const output = await run('path/to/document.pdf', {
-      outputFolder: 'path/to/output',
-      generateMarkdown: true,
-      generateHtml: true,
-      generateAnnotatedPdf: true,
-      debug: true,
+    await convert(['path/to/document.pdf', 'path/to/folder'], {
+      outputDir: 'path/to/output',
+      format: ['json', 'html', 'pdf', 'markdown'],
     });
-    console.log('PDF processing complete.', output);
+    console.log('convert() complete');
   } catch (error) {
     console.error('Error processing PDF:', error);
   }
@@ -175,60 +171,63 @@ async function main() {
 
 main();
 ```
+### Function: convert()
+
+`convert(inputPaths: string[], options?: ConvertOptions): Promise<string>`
+
+Multi-input helper matching the Python wrapper.
+
+| Property                        | Type       | Default     | Description                                                                                                                         |
+| --------------------------------| ---------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `inputPaths`                    | `string[]` | —           | One or more file paths or directories to process.                                                                                   |
+| `options.outputDir`             | `string`   | `undefined` | Directory where outputs are written.                                                                                                |
+| `options.password`              | `string`   | `undefined` | Password for encrypted PDFs.                                                                                                        |
+| `options.format`                | `string[]` | `undefined` | Output formats (any combination of `json`, `text`, `html`, `pdf`, `markdown`, `markdown-with-html`, `markdown-with-images`).        |
+| `options.quiet`                 | `boolean`  | `false`     | Suppress CLI logging output and prevent streaming.                                                                                  |
+| `options.contentSafetyOff`      | `string[]` | `undefined` | Disable one or more content safety filters (`all`, `hidden-text`, `off-page`, `tiny`, `hidden-ocg`).                                |
+| `options.keepLineBreaks`        | `boolean`  | `false`     | Preserve line breaks in text output.                                                                                                |
+| `options.replaceInvalidChars`   | `string`   | `undefined` | Replacement character for invalid or unrecognized characters.                                                                       |
+
+### Function: run()
+
+Deprecated.
 
-If you want to run it via CLI, you can use the following command:
+### CLI
 
 ```bash
-npx @opendataloader/pdf path/to/document.pdf -o path/to/output --markdown --html --pdf
+npx @opendataloader/pdf path/to/document.pdf path/to/folder -o path/to/output -f json html pdf markdown
 ```
 
-or you can install it globally:
+Or install globally:
 
 ```bash
 npm install -g @opendataloader/pdf
 ```
 
-then run:
+Then run:
 
 ```bash
-opendataloader-pdf path/to/document.pdf -o path/to/output --markdown --html --pdf
+opendataloader-pdf path/to/document.pdf path/to/folder -o path/to/output -f json html pdf markdown
 ```
 
-### Function: run()
-
-`run(inputPath: string, options?: RunOptions): Promise<string>`
+#### Available options
 
-The main function to process PDFs.
-
-**Parameters**
-
-| Parameter   | Type     | Required | Description                           |
-| ----------- | -------- | -------- | ------------------------------------- |
-| `inputPath` | `string` | ✅ Yes    | Path to the input PDF file or folder. |
-| `options`   | `RunOptions` | No       | Configuration options for the run.    |
-
-**RunOptions**
-
-| Property                | Type      | Default       | Description                                                                                                                                           |
-| ----------------------- | --------- | ------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `outputFolder`          | `string`  | `undefined`   | Path to the output folder. If not set, output is saved next to the input.                                                                             |
-| `password`              | `string`  | `undefined`   | Password for the PDF file.                                                                                                                            |
-| `replaceInvalidChars`   | `string`  | `" "`         | Character to replace invalid or unrecognized characters (e.g., , \u0000).                                                                             |
-| `contentSafetyOff`     | `string`  | `undefined`   | Disables one or more content safety filters. Accepts a comma-separated list of filter names. Arguments: all, hidden-text, off-page, tiny, hidden-ocg. |
-| `generateMarkdown`      | `boolean` | `false`       | If `true`, generates a Markdown output file.                                                                                                          |
-| `generateHtml`          | `boolean` | `false`       | If `true`, generates an HTML output file.                                                                                                             |
-| `generateAnnotatedPdf`  | `boolean` | `false`       | If `true`, generates an annotated PDF output file.                                                                                                    |
-| `keepLineBreaks`        | `boolean` | `false`       | If `true`, keeps line breaks in the output.                                                                                                           |
-| `htmlInMarkdown`        | `boolean` | `false`       | If `true`, uses HTML in the Markdown output.                                                                                                          |
-| `addImageToMarkdown`    | `boolean` | `false`       | If `true`, adds images to the Markdown output.                                                                                                        |
-| `noJson`                | `boolean` | `false`       | If `true`, disables the JSON output.                                                                                                                  |
-| `debug`                 | `boolean` | `false`       | If `true`, prints CLI messages to the console during execution.                                                                                       |
+```
+  -o, --output-dir <path>             Directory where outputs are written
+  -p, --password <password>           Password for encrypted PDFs
+  -f, --format <value...>             Output formats to generate (json, text, html, pdf, markdown, markdown-with-html, markdown-with-images)
+  -q, --quiet                         Suppress CLI logging output
+      --content-safety-off <mode...>  Disable one or more content safety filters (all, hidden-text, off-page, tiny, hidden-ocg)
+      --keep-line-breaks              Preserve line breaks in text output
+      --replace-invalid-chars <c>     Replacement character for invalid or unrecognized characters
+  -h, --help                          Show usage information
+```
 
 <br/>
 
 ## Java
 
-For various example templates, including Gradle and Maven, please refer to https://github.com/opendataloader-project/opendataloader-pdf/tree/main/examples/java.
+For various example templates, including Gradle and Maven, please refer to [Examples](https://github.com/opendataloader-project/opendataloader-pdf-examples).
 
 ### Dependency
 
@@ -244,7 +243,7 @@ Check for the latest version on [Maven Central](https://search.maven.org/artifac
         <dependency>
             <groupId>org.opendataloader</groupId>
             <artifactId>opendataloader-pdf-core</artifactId>
-            <version>1.0.0</version>
+            <version>1.1.2</version>
         </dependency>
     </dependencies>
 

{opendataloader_pdf-1.1.1.dist-info → opendataloader_pdf-1.1.3.dist-info}/RECORD

@@ -14,9 +14,9 @@ opendataloader_pdf/THIRD_PARTY/licenses/LICENSE-JJ2000.txt,sha256=itSesIy3XiNWgJ
 opendataloader_pdf/THIRD_PARTY/licenses/MIT.txt,sha256=JPCdbR3BU0uO_KypOd3sGWnKwlVHGq4l0pmrjoGtop8,1078
 opendataloader_pdf/THIRD_PARTY/licenses/MPL-2.0.txt,sha256=CGF6Fx5WV7DJmRZJ8_6w6JEt2N9bu4p6zDo18fTHHRw,15818
 opendataloader_pdf/THIRD_PARTY/licenses/Plexus Classworlds License.txt,sha256=ZQuKXwVz4FeC34ApB20vYg8kPTwgIUKRzEk5ew74-hU,1937
-opendataloader_pdf/jar/opendataloader-pdf-cli.jar,sha256=WjlTt3xWmCO_shYd8b13G_SdidD0Y2CqZiAbbh360vc,20485422
-opendataloader_pdf-1.1.1.dist-info/METADATA,sha256=Rn2U8ighQJivylQGtf1mvZwgK0wqh6lIAM3r9Yjn-mw,25270
-opendataloader_pdf-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opendataloader_pdf-1.1.1.dist-info/entry_points.txt,sha256=Tupa9pVNF6nXD9sqzCLI8PCHbSu0jKkL3SYyTkQy0dc,71
-opendataloader_pdf-1.1.1.dist-info/top_level.txt,sha256=xee0qFQd6HPfS50E2NLICGuR6cq9C9At5SJ81yv5HkY,19
-opendataloader_pdf-1.1.1.dist-info/RECORD,,
+opendataloader_pdf/jar/opendataloader-pdf-cli.jar,sha256=lO7KQMXlaldURR_RoOC5nZ_kiVNbjDPxlBHZp-ro0Rg,20540216
+opendataloader_pdf-1.1.3.dist-info/METADATA,sha256=eeGkaZt33Flu_X-wWu9EjFE2XOsxc7oqQxIM7_I8jIc,24562
+opendataloader_pdf-1.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+opendataloader_pdf-1.1.3.dist-info/entry_points.txt,sha256=Tupa9pVNF6nXD9sqzCLI8PCHbSu0jKkL3SYyTkQy0dc,71
+opendataloader_pdf-1.1.3.dist-info/top_level.txt,sha256=xee0qFQd6HPfS50E2NLICGuR6cq9C9At5SJ81yv5HkY,19
+opendataloader_pdf-1.1.3.dist-info/RECORD,,