docling-core 2.0.0__tar.gz → 2.0.1__tar.gz

{docling_core-2.0.0 → docling_core-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docling-core
-Version: 2.0.0
+Version: 2.0.1
 Summary: A python library to define and validate data types in Docling.
 Home-page: https://ds4sd.github.io/
 License: MIT
@@ -72,20 +72,20 @@ poetry run pytest test
 - You can validate your JSON objects using the pydantic class definition.
 
   ```py
-  from docling_core.types import Document
+  from docling_core.types import DoclingDocument
 
   data_dict = {...}  # here the object you want to validate, as a dictionary
-  Document.model_validate(data_dict)
+  DoclingDocument.model_validate(data_dict)
 
   data_str = {...}  # here the object as a JSON string
-  Document.model_validate_json(data_str)
+  DoclingDocument.model_validate_json(data_str)
   ```
 
 - You can generate the JSON schema of a model with the script `generate_jsonschema`.
 
   ```py
-  # for the `Document` type
-  generate_jsonschema Document
+  # for the `DoclingDocument` type
+  generate_jsonschema DoclingDocument
 
   # for the use `Record` type
   generate_jsonschema Record
@@ -93,16 +93,16 @@ poetry run pytest test
 
 ## Documentation
 
-Docling supports 3 main data types:
+Docling Core contains 3 top-level data types:
 
-- **Document** for publications like books, articles, reports, or patents. When Docling converts an unstructured PDF document, the generated JSON follows this schema.
-  The Document type also models the metadata that may be attached to the converted document.
-  Check [Document](docs/Document.json) for the full JSON schema. 
+- **DoclingDocument** for publications like books, articles, reports, or patents. When Docling converts an unstructured PDF document, the generated JSON follows this schema.
+  The DoclingDocument type also models the metadata that may be attached to the converted document.
+  Check [DoclingDocument](docs/DoclingDocument.json) for the full JSON schema.
 - **Record** for structured database records, centered on an entity or _subject_ that is provided with a list of attributes.
   Related to records, the statements can represent annotations on text by Natural Language Processing (NLP) tools.
-  Check [Record](docs/Record.json) for the full JSON schema. 
+  Check [Record](docs/Record.json) for the full JSON schema.
 - **Generic** for any data representation, ensuring minimal configuration and maximum flexibility.
-  Check [Generic](docs/Generic.json) for the full JSON schema. 
+  Check [Generic](docs/Generic.json) for the full JSON schema.
 
 The data schemas are defined using [pydantic](https://pydantic-docs.helpmanual.io/) models, which provide built-in processes to support the creation of data that adhere to those models.
 

{docling_core-2.0.0 → docling_core-2.0.1}/README.md

@@ -36,20 +36,20 @@ poetry run pytest test
 - You can validate your JSON objects using the pydantic class definition.
 
   ```py
-  from docling_core.types import Document
+  from docling_core.types import DoclingDocument
 
   data_dict = {...}  # here the object you want to validate, as a dictionary
-  Document.model_validate(data_dict)
+  DoclingDocument.model_validate(data_dict)
 
   data_str = {...}  # here the object as a JSON string
-  Document.model_validate_json(data_str)
+  DoclingDocument.model_validate_json(data_str)
   ```
 
 - You can generate the JSON schema of a model with the script `generate_jsonschema`.
 
   ```py
-  # for the `Document` type
-  generate_jsonschema Document
+  # for the `DoclingDocument` type
+  generate_jsonschema DoclingDocument
 
   # for the use `Record` type
   generate_jsonschema Record
@@ -57,16 +57,16 @@ poetry run pytest test
 
 ## Documentation
 
-Docling supports 3 main data types:
+Docling Core contains 3 top-level data types:
 
-- **Document** for publications like books, articles, reports, or patents. When Docling converts an unstructured PDF document, the generated JSON follows this schema.
-  The Document type also models the metadata that may be attached to the converted document.
-  Check [Document](docs/Document.json) for the full JSON schema. 
+- **DoclingDocument** for publications like books, articles, reports, or patents. When Docling converts an unstructured PDF document, the generated JSON follows this schema.
+  The DoclingDocument type also models the metadata that may be attached to the converted document.
+  Check [DoclingDocument](docs/DoclingDocument.json) for the full JSON schema.
 - **Record** for structured database records, centered on an entity or _subject_ that is provided with a list of attributes.
   Related to records, the statements can represent annotations on text by Natural Language Processing (NLP) tools.
-  Check [Record](docs/Record.json) for the full JSON schema. 
+  Check [Record](docs/Record.json) for the full JSON schema.
 - **Generic** for any data representation, ensuring minimal configuration and maximum flexibility.
-  Check [Generic](docs/Generic.json) for the full JSON schema. 
+  Check [Generic](docs/Generic.json) for the full JSON schema.
 
 The data schemas are defined using [pydantic](https://pydantic-docs.helpmanual.io/) models, which provide built-in processes to support the creation of data that adhere to those models.
 

docling_core-2.0.1/docling_core/types/__init__.py

@@ -0,0 +1,10 @@
+#
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: MIT
+#
+
+"""Define the main types."""
+
+from docling_core.types.doc.document import DoclingDocument
+from docling_core.types.gen.generic import Generic
+from docling_core.types.rec.record import Record

{docling_core-2.0.0 → docling_core-2.0.1}/docling_core/types/doc/document.py

@@ -214,6 +214,7 @@ class DocumentOrigin(BaseModel):
         "application/vnd.openxmlformats-officedocument.presentationml.template",
         "application/vnd.openxmlformats-officedocument.presentationml.slideshow",
         "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+        "text/asciidoc",
     ]
 
     @field_validator("binary_hash", mode="before")

{docling_core-2.0.0 → docling_core-2.0.1}/docling_core/utils/generate_docs.py

@@ -18,7 +18,7 @@ from typing import Final
 
 from docling_core.utils.generate_jsonschema import generate_json_schema
 
-MODELS: Final = ["Document", "Record", "Generic"]
+MODELS: Final = ["DoclingDocument", "Record", "Generic"]
 
 
 def _prepare_directory(folder: str, clean: bool = False) -> None:

{docling_core-2.0.0 → docling_core-2.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docling-core"
-version = "2.0.0"
+version = "2.0.1"
 description = "A python library to define and validate data types in Docling."
 license = "MIT"
 authors = [

docling_core-2.0.0/docling_core/types/__init__.py

@@ -1,29 +0,0 @@
-#
-# Copyright IBM Corp. 2024 - 2024
-# SPDX-License-Identifier: MIT
-#
-
-"""Define the main types."""
-
-from docling_core.types.gen.generic import Generic  # noqa
-from docling_core.types.legacy_doc.base import BoundingBox  # noqa
-from docling_core.types.legacy_doc.base import Table  # noqa
-from docling_core.types.legacy_doc.base import TableCell  # noqa
-from docling_core.types.legacy_doc.base import (  # noqa
-    BaseCell,
-    BaseText,
-    PageDimensions,
-    PageReference,
-    Prov,
-    Ref,
-)
-from docling_core.types.legacy_doc.document import (  # noqa
-    CCSDocumentDescription as DocumentDescription,
-)
-from docling_core.types.legacy_doc.document import (  # noqa
-    CCSFileInfoObject as FileInfoObject,
-)
-from docling_core.types.legacy_doc.document import (  # noqa
-    ExportedCCSDocument as Document,
-)
-from docling_core.types.rec.record import Record  # noqa