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.36.0.tar.gz (143.5 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.36.0-py3-none-any.whl (148.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docling_core-2.36.0.tar.gz
  • Upload date:
  • Size: 143.5 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.36.0.tar.gz
Algorithm Hash digest
SHA256 31d8538dc4cc113a07f2fd173440e2147759579b3a5cf232eecb76a42cb7790a
MD5 ced6b8afde05908900048c1f80a74752
BLAKE2b-256 9ff853826c965af50891c0c46cf9853796fd9246095e984d3a5987006fe4b7cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for docling_core-2.36.0.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.36.0-py3-none-any.whl.

File metadata

  • Download URL: docling_core-2.36.0-py3-none-any.whl
  • Upload date:
  • Size: 148.6 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.36.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a66b3ec605290369a4b3f029585e17201978b03dbded3cca604ec21c74c85466
MD5 676958f76b3484a3c687a5a66e7cf935
BLAKE2b-256 e586e78d7edb08557627786a1c435f3e938e55d5964aaa178768beb20594f49e

See more details on using hashes here.

Provenance

The following attestation bundles were made for docling_core-2.36.0-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