Skip to main content

A python library to define and validate data types in Docling.

Project description

Docling Core

PyPI version Python uv Code style: black Imports: isort Checked with mypy Pydantic v2 pre-commit License MIT

Docling Core is a library that defines core data types and transformations in Docling.

Installation

To use Docling Core, simply install docling-core from your package manager, e.g. pip:

pip install docling-core

Development setup

To develop for Docling Core, you need Python 3.9 / 3.10 / 3.11 / 3.12 / 3.13 and uv. You can then install from your local clone's root dir:

uv sync --all-extras

To run the pytest suite, execute:

uv run pytest -s test

Main features

Docling Core provides the foundational DoclingDocument data model and API, as well as additional APIs for tasks like serialization and chunking, which are key to developing generative AI applications using Docling.

DoclingDocument

Docling Core defines the DoclingDocument as a Pydantic model, allowing for advanced data model control, customizability, and interoperability.

In addition to specifying the schema, it provides a handy API for building documents, as well as for basic operations, e.g. exporting to various formats, like Markdown, HTML, and others.

👉 More details:

Serialization

Different users can have varying requirements when it comes to serialization. To address this, the Serialization API introduces a design that allows easy extension, while providing feature-rich built-in implementations (on which the respective DoclingDocument helpers are actually based).

👉 More details:

Chunking

Similarly to above, the Chunking API provides built-in chunking capabilities as well as a design that enables easy extension, this way tackling customization requirements of different use cases.

👉 More details:

Contributing

Please read Contributing to Docling Core for details.

References

If you use Docling Core in your projects, please consider citing the following:

@techreport{Docling,
  author = "Deep Search Team",
  month = 8,
  title = "Docling Technical Report",
  url = "https://arxiv.org/abs/2408.09869",
  eprint = "2408.09869",
  doi = "10.48550/arXiv.2408.09869",
  version = "1.0.0",
  year = 2024
}

License

The Docling Core codebase is under MIT license. For individual model usage, please refer to the model licenses found in the original packages.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docling_core-2.34.1.tar.gz (142.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docling_core-2.34.1-py3-none-any.whl (146.7 kB view details)

Uploaded Python 3

File details

Details for the file docling_core-2.34.1.tar.gz.

File metadata

  • Download URL: docling_core-2.34.1.tar.gz
  • Upload date:
  • Size: 142.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docling_core-2.34.1.tar.gz
Algorithm Hash digest
SHA256 c9cdf6413693a5bdfce7d276644d16a337938ce07ace643c460e2d9da1787c01
MD5 2f32c879bc28cbb2b93ec3d49db87981
BLAKE2b-256 9956e6017eb07d1d895fe411fe1723e8a28c9fef36e4ef18bb81a83492969f34

See more details on using hashes here.

Provenance

The following attestation bundles were made for docling_core-2.34.1.tar.gz:

Publisher: pypi.yml on docling-project/docling-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docling_core-2.34.1-py3-none-any.whl.

File metadata

  • Download URL: docling_core-2.34.1-py3-none-any.whl
  • Upload date:
  • Size: 146.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docling_core-2.34.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c7f2c31d84791a0d8f7b2996abceef0c0debbff30725de899fb62401278ccb9f
MD5 666ab8383c671fa583e32fc38a162496
BLAKE2b-256 f84de360e87a4cc54056cbb6838051254bd13b01a44a195d9d93a170f5e0cac3

See more details on using hashes here.

Provenance

The following attestation bundles were made for docling_core-2.34.1-py3-none-any.whl:

Publisher: pypi.yml on docling-project/docling-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page