PyPI - docling-core - Versions diffs - 1.1.0__tar.gz → 1.1.2__tar.gz - Mend

docling-core 1.1.0tar.gz → 1.1.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of docling-core might be problematic. Click here for more details.

Files changed (45) hide show

{docling_core-1.1.0 → docling_core-1.1.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docling-core
-Version: 1.1.0
+Version: 1.1.2
 Summary: A python library to define and validate data types in Docling.
 Home-page: https://ds4sd.github.io/
 License: MIT
@@ -35,36 +35,35 @@ Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Project-URL: Repository, https://github.com/DS4SD/docling-core
 Description-Content-Type: text/markdown
+# Docling Core
 [![PyPI version](https://img.shields.io/pypi/v/docling-core)](https://pypi.org/project/docling-core/)
-![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)
+![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.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/)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![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 Core
+[![License MIT](https://img.shields.io/github/license/ds4sd/docling-core)](https://opensource.org/licenses/MIT)
 Docling Core is a library that defines the data types in [Docling](https://ds4sd.github.io), leveraging pydantic models.
 ## Installation
-Using [Poetry](https://python-poetry.org), create and activate a virtual environment.
-```
-poetry shell
+To use Docling Core, simply install `docling-core` from your package manager, e.g. pip:
+```bash
+pip install docling-core
 ```
-Install the defined dependencies of the project.
+### Development setup
-```
+To develop for Docling Core, you need Python 3.9 / 3.10 / 3.11 / 3.12 and Poetry. You can then install from your local clone's root dir:
+```bash
 poetry install
 ```
-Test the installation running the pytest suite.
+To run the pytest suite, execute:
 ```
 poetry run pytest test
 ```
@@ -114,7 +113,7 @@ Please read [Contributing to Docling Core](./CONTRIBUTING.md) for details.
 ## References
-If you use `Docling Core` in your projects, please consider citing the following:
+If you use Docling Core in your projects, please consider citing the following:
 ```bib
 @software{Docling,
@@ -129,6 +128,6 @@ year = {2024}
 ## License
-The `Docling Core` codebase is under MIT license.
+The Docling Core codebase is under MIT license.
 For individual model usage, please refer to the model licenses found in the original packages.

{docling_core-1.1.0 → docling_core-1.1.2}/README.md RENAMED Viewed

@@ -1,33 +1,32 @@
+# Docling Core
 [![PyPI version](https://img.shields.io/pypi/v/docling-core)](https://pypi.org/project/docling-core/)
-![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)
+![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.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/)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![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 Core
+[![License MIT](https://img.shields.io/github/license/ds4sd/docling-core)](https://opensource.org/licenses/MIT)
 Docling Core is a library that defines the data types in [Docling](https://ds4sd.github.io), leveraging pydantic models.
 ## Installation
-Using [Poetry](https://python-poetry.org), create and activate a virtual environment.
-```
-poetry shell
+To use Docling Core, simply install `docling-core` from your package manager, e.g. pip:
+```bash
+pip install docling-core
 ```
-Install the defined dependencies of the project.
+### Development setup
-```
+To develop for Docling Core, you need Python 3.9 / 3.10 / 3.11 / 3.12 and Poetry. You can then install from your local clone's root dir:
+```bash
 poetry install
 ```
-Test the installation running the pytest suite.
+To run the pytest suite, execute:
 ```
 poetry run pytest test
 ```
@@ -77,7 +76,7 @@ Please read [Contributing to Docling Core](./CONTRIBUTING.md) for details.
 ## References
-If you use `Docling Core` in your projects, please consider citing the following:
+If you use Docling Core in your projects, please consider citing the following:
 ```bib
 @software{Docling,
@@ -92,5 +91,5 @@ year = {2024}
 ## License
-The `Docling Core` codebase is under MIT license.
+The Docling Core codebase is under MIT license.
 For individual model usage, please refer to the model licenses found in the original packages.

{docling_core-1.1.0 → docling_core-1.1.2}/docling_core/search/package.py RENAMED Viewed

@@ -26,7 +26,7 @@ class Package(BaseModel, extra="forbid"):
     The version needs to comply with Semantic Versioning 2.0.0.
     """
-    name: StrictStr
+    name: StrictStr = "docling-core"
     version: Annotated[str, StringConstraints(strict=True, pattern=VERSION_PATTERN)] = (
         importlib.metadata.version("docling-core")
     )

{docling_core-1.1.0 → docling_core-1.1.2}/docling_core/types/doc/base.py RENAMED Viewed

@@ -6,7 +6,7 @@
 """Define common models across CCS objects."""
 from typing import Annotated, Literal, Optional, Union
-from pydantic import BaseModel, Field, StrictStr
+from pydantic import BaseModel, Field, PositiveInt, StrictStr
 from docling_core.search.mapping import es_field
 from docling_core.utils.alias import AliasModel
@@ -39,7 +39,7 @@ class S3Resource(BaseModel):
     mime: str
     path: str
-    page: Optional[int] = None
+    page: Optional[PositiveInt] = None
 class S3Data(AliasModel):
@@ -68,7 +68,7 @@ class Prov(AliasModel):
     """Provenance."""
     bbox: BoundingBox
-    page: int
+    page: PositiveInt
     span: Span
     ref_s3_data: Optional[StrictStr] = Field(
         default=None, alias="__ref_s3_data", json_schema_extra=es_field(suppress=True)
@@ -96,7 +96,7 @@ class PageDimensions(BaseModel):
     """Page dimensions."""
     height: float
-    page: int
+    page: PositiveInt
     width: float
@@ -196,4 +196,4 @@ class PageReference(BaseModel):
     hash: str = Field(json_schema_extra=es_field(type="keyword", ignore_above=8191))
     model: str = Field(json_schema_extra=es_field(suppress=True))
-    page: int = Field(json_schema_extra=es_field(type="short"))
+    page: PositiveInt = Field(json_schema_extra=es_field(type="short"))

{docling_core-1.1.0 → docling_core-1.1.2}/docling_core/types/doc/document.py RENAMED Viewed

@@ -263,7 +263,7 @@ class MinimalDocument(
     """Minimal model for a document."""
     name: StrictStr = Field(alias="_name")
-    obj_type: StrictStr = Field("document", alias="type")
+    obj_type: Optional[StrictStr] = Field("document", alias="type")
     description: CCSDocumentDescription[
         DescriptionAdvancedT,
         DescriptionAnalyticsT,
@@ -291,7 +291,7 @@ class CCSDocument(
 ):
     """Model for a CCS-generated document."""
-    obj_type: StrictStr = Field("pdf-document", alias="type")
+    obj_type: Optional[StrictStr] = Field("pdf-document", alias="type")
     bitmaps: Optional[list[BitmapObject]] = None
     equations: Optional[list[BaseCell]] = None
     footnotes: Optional[list[BaseText]] = None
@@ -355,7 +355,7 @@ class ExportedCCSDocument(
 ):
     """Document model for Docling."""
-    obj_type: StrictStr = Field(
+    obj_type: Optional[StrictStr] = Field(
         "pdf-document",
         alias="type",
         json_schema_extra=es_field(type="keyword", ignore_above=8191),

{docling_core-1.1.0 → docling_core-1.1.2}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docling-core"
-version = "1.1.0"
+version = "1.1.2"
 description = "A python library to define and validate data types in Docling."
 license = "MIT"
 authors = [
@@ -58,7 +58,7 @@ tabulate = "^0.9.0"
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
 pytest = "^7.1.2"
-mypy = "^v1.6.0"
+mypy = "^1.6.0"
 isort = "^5.10.1"
 pre-commit = "^3.7.1"
 autoflake = "^2.0.0"