docling 0.3.0__tar.gz → 0.3.1__tar.gz

{docling-0.3.0 → docling-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docling
-Version: 0.3.0
+Version: 0.3.1
 Summary: Docling PDF conversion package
 Home-page: https://github.com/DS4SD/docling
 License: MIT
@@ -31,11 +31,20 @@ Project-URL: Repository, https://github.com/DS4SD/docling
 Description-Content-Type: text/markdown
 
 <p align="center">
-  <a href="https://github.com/ds4sd/docling"> <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/logo.png" width="150" /> </a>
+  <a href="https://github.com/ds4sd/docling"> <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/logo.png" width="150" />
 </p>
 
 # Docling
 
+[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/)
+![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12-blue)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![License MIT](https://img.shields.io/github/license/ds4sd/deepsearch-toolkit)](https://opensource.org/licenses/MIT)
+
 Docling bundles PDF document conversion to JSON and Markdown in an easy, self-contained package.
 
 ## Features
@@ -44,25 +53,20 @@ Docling bundles PDF document conversion to JSON and Markdown in an easy, self-co
 * 📝 Extracts metadata from the document, such as title, authors, references and language
 * 🔍 Optionally applies OCR (use with scanned PDFs)
 
-## Setup
+## Installation
 
-For general usage, you can simply install `docling` through `pip` from the pypi package index.
-```
+To use Docling, simply install `docling` from your package manager, e.g. pip:
+```bash
 pip install docling
 ```
 
-**Notes**:
-* Works on macOS and Linux environments. Windows platforms are currently not tested.
+> [!NOTE]  
+> Works on macOS and Linux environments. Windows platforms are currently not tested.
 
 ### Development setup
 
-To develop for `docling`, you need Python 3.11 and `poetry`. Install poetry from [here](https://python-poetry.org/docs/#installing-with-the-official-installer).
-
-Once you have `poetry` installed and cloned this repo, create an environment and install `docling` from the repo root:
-
+To develop for Docling, you need Python 3.11 / 3.12 and Poetry. You can then install from your local clone's root dir:
 ```bash
-poetry env use $(which python3.11)
-poetry shell
 poetry install
 ```
 
@@ -77,23 +81,24 @@ The output of the above command will be written to `./scratch`.
 
 ### Enable or disable pipeline features
 
-You can control if table structure recognition or OCR should be performed by arguments passed to `DocumentConverter` 
+You can control if table structure recognition or OCR should be performed by arguments passed to `DocumentConverter`:
 ```python
 doc_converter = DocumentConverter(
     artifacts_path=artifacts_path,
-    pipeline_options=PipelineOptions(do_table_structure=False, # Controls if table structure is recovered. 
-                                     do_ocr=True), # Controls if OCR is applied (ignores programmatic content)
+    pipeline_options=PipelineOptions(
+        do_table_structure=False,  # controls if table structure is recovered 
+        do_ocr=True,  # controls if OCR is applied (ignores programmatic content)
+    ),
 )
 ```
 
 ### Impose limits on the document size
 
-You can limit the file size and number of pages which should be allowed to process per document.
+You can limit the file size and number of pages which should be allowed to process per document:
 ```python
-paths = [Path("./test/data/2206.01062.pdf")]
-
-input = DocumentConversionInput.from_paths(
-    paths, limits=DocumentLimits(max_num_pages=100, max_file_size=20971520)
+conv_input = DocumentConversionInput.from_paths(
+    paths=[Path("./test/data/2206.01062.pdf")],
+    limits=DocumentLimits(max_num_pages=100, max_file_size=20971520)
 )
 ```
 
@@ -103,12 +108,12 @@ You can convert PDFs from a binary stream instead of from the filesystem as foll
 ```python
 buf = BytesIO(your_binary_stream)
 docs = [DocumentStream(filename="my_doc.pdf", stream=buf)]
-input = DocumentConversionInput.from_streams(docs)
-converted_docs = doc_converter.convert(input)
+conv_input = DocumentConversionInput.from_streams(docs)
+converted_docs = doc_converter.convert(conv_input)
 ```
 ### Limit resource usage
 
-You can limit the CPU threads used by `docling` by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads.
+You can limit the CPU threads used by Docling by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads.
 
 
 ## Contributing
@@ -118,7 +123,7 @@ Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main
 
 ## References
 
-If you use `Docling` in your projects, please consider citing the following:
+If you use Docling in your projects, please consider citing the following:
 
 ```bib
 @software{Docling,
@@ -133,6 +138,6 @@ year = {2024}
 
 ## License
 
-The `Docling` codebase is under MIT license.
+The Docling codebase is under MIT license.
 For individual model usage, please refer to the model licenses found in the original packages.
 

docling-0.3.1/README.md

@@ -0,0 +1,110 @@
+<p align="center">
+  <a href="https://github.com/ds4sd/docling"> <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/logo.png" width="150" />
+</p>
+
+# Docling
+
+[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/)
+![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12-blue)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![License MIT](https://img.shields.io/github/license/ds4sd/deepsearch-toolkit)](https://opensource.org/licenses/MIT)
+
+Docling bundles PDF document conversion to JSON and Markdown in an easy, self-contained package.
+
+## Features
+* ⚡ Converts any PDF document to JSON or Markdown format, stable and lightning fast
+* 📑 Understands detailed page layout, reading order and recovers table structures
+* 📝 Extracts metadata from the document, such as title, authors, references and language
+* 🔍 Optionally applies OCR (use with scanned PDFs)
+
+## Installation
+
+To use Docling, simply install `docling` from your package manager, e.g. pip:
+```bash
+pip install docling
+```
+
+> [!NOTE]  
+> Works on macOS and Linux environments. Windows platforms are currently not tested.
+
+### Development setup
+
+To develop for Docling, you need Python 3.11 / 3.12 and Poetry. You can then install from your local clone's root dir:
+```bash
+poetry install
+```
+
+## Usage
+
+For basic usage, see the [convert.py](https://github.com/DS4SD/docling/blob/main/examples/convert.py) example module. Run with:
+
+```
+python examples/convert.py
+```
+The output of the above command will be written to `./scratch`.
+
+### Enable or disable pipeline features
+
+You can control if table structure recognition or OCR should be performed by arguments passed to `DocumentConverter`:
+```python
+doc_converter = DocumentConverter(
+    artifacts_path=artifacts_path,
+    pipeline_options=PipelineOptions(
+        do_table_structure=False,  # controls if table structure is recovered 
+        do_ocr=True,  # controls if OCR is applied (ignores programmatic content)
+    ),
+)
+```
+
+### Impose limits on the document size
+
+You can limit the file size and number of pages which should be allowed to process per document:
+```python
+conv_input = DocumentConversionInput.from_paths(
+    paths=[Path("./test/data/2206.01062.pdf")],
+    limits=DocumentLimits(max_num_pages=100, max_file_size=20971520)
+)
+```
+
+### Convert from binary PDF streams 
+
+You can convert PDFs from a binary stream instead of from the filesystem as follows:
+```python
+buf = BytesIO(your_binary_stream)
+docs = [DocumentStream(filename="my_doc.pdf", stream=buf)]
+conv_input = DocumentConversionInput.from_streams(docs)
+converted_docs = doc_converter.convert(conv_input)
+```
+### Limit resource usage
+
+You can limit the CPU threads used by Docling by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads.
+
+
+## Contributing
+
+Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details.
+
+
+## References
+
+If you use Docling in your projects, please consider citing the following:
+
+```bib
+@software{Docling,
+author = {Deep Search Team},
+month = {7},
+title = {{Docling}},
+url = {https://github.com/DS4SD/docling},
+version = {main},
+year = {2024}
+}
+```
+
+## License
+
+The Docling codebase is under MIT license.
+For individual model usage, please refer to the model licenses found in the original packages.

{docling-0.3.0 → docling-0.3.1}/docling/datamodel/document.py

@@ -117,9 +117,9 @@ class ConvertedDocument(BaseModel):
     errors: List[Dict] = []  # structure to keep errors
 
     pages: List[Page] = []
-    assembled: AssembledUnit = None
+    assembled: Optional[AssembledUnit] = None
 
-    output: DsDocument = None
+    output: Optional[DsDocument] = None
 
     def to_ds_document(self) -> DsDocument:
         title = ""

{docling-0.3.0 → docling-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docling"
-version = "0.3.0"  # DO NOT EDIT, updated automatically
+version = "0.3.1"  # DO NOT EDIT, updated automatically
 description = "Docling PDF conversion package"
 authors = ["Christoph Auer <cau@zurich.ibm.com>", "Michele Dolfi <dol@zurich.ibm.com>", "Maxim Lysak <mly@zurich.ibm.com>", "Nikos Livathinos <nli@zurich.ibm.com>", "Ahmed Nassar <ahn@zurich.ibm.com>", "Peter Staar <taa@zurich.ibm.com>"]
 license = "MIT"

docling-0.3.0/README.md

@@ -1,105 +0,0 @@
-<p align="center">
-  <a href="https://github.com/ds4sd/docling"> <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/logo.png" width="150" /> </a>
-</p>
-
-# Docling
-
-Docling bundles PDF document conversion to JSON and Markdown in an easy, self-contained package.
-
-## Features
-* ⚡ Converts any PDF document to JSON or Markdown format, stable and lightning fast
-* 📑 Understands detailed page layout, reading order and recovers table structures
-* 📝 Extracts metadata from the document, such as title, authors, references and language
-* 🔍 Optionally applies OCR (use with scanned PDFs)
-
-## Setup
-
-For general usage, you can simply install `docling` through `pip` from the pypi package index.
-```
-pip install docling
-```
-
-**Notes**:
-* Works on macOS and Linux environments. Windows platforms are currently not tested.
-
-### Development setup
-
-To develop for `docling`, you need Python 3.11 and `poetry`. Install poetry from [here](https://python-poetry.org/docs/#installing-with-the-official-installer).
-
-Once you have `poetry` installed and cloned this repo, create an environment and install `docling` from the repo root:
-
-```bash
-poetry env use $(which python3.11)
-poetry shell
-poetry install
-```
-
-## Usage
-
-For basic usage, see the [convert.py](https://github.com/DS4SD/docling/blob/main/examples/convert.py) example module. Run with:
-
-```
-python examples/convert.py
-```
-The output of the above command will be written to `./scratch`.
-
-### Enable or disable pipeline features
-
-You can control if table structure recognition or OCR should be performed by arguments passed to `DocumentConverter` 
-```python
-doc_converter = DocumentConverter(
-    artifacts_path=artifacts_path,
-    pipeline_options=PipelineOptions(do_table_structure=False, # Controls if table structure is recovered. 
-                                     do_ocr=True), # Controls if OCR is applied (ignores programmatic content)
-)
-```
-
-### Impose limits on the document size
-
-You can limit the file size and number of pages which should be allowed to process per document.
-```python
-paths = [Path("./test/data/2206.01062.pdf")]
-
-input = DocumentConversionInput.from_paths(
-    paths, limits=DocumentLimits(max_num_pages=100, max_file_size=20971520)
-)
-```
-
-### Convert from binary PDF streams 
-
-You can convert PDFs from a binary stream instead of from the filesystem as follows:
-```python
-buf = BytesIO(your_binary_stream)
-docs = [DocumentStream(filename="my_doc.pdf", stream=buf)]
-input = DocumentConversionInput.from_streams(docs)
-converted_docs = doc_converter.convert(input)
-```
-### Limit resource usage
-
-You can limit the CPU threads used by `docling` by setting the environment variable `OMP_NUM_THREADS` accordingly. The default setting is using 4 CPU threads.
-
-
-## Contributing
-
-Please read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details.
-
-
-## References
-
-If you use `Docling` in your projects, please consider citing the following:
-
-```bib
-@software{Docling,
-author = {Deep Search Team},
-month = {7},
-title = {{Docling}},
-url = {https://github.com/DS4SD/docling},
-version = {main},
-year = {2024}
-}
-```
-
-## License
-
-The `Docling` codebase is under MIT license.
-For individual model usage, please refer to the model licenses found in the original packages.