docling


Namedocling JSON
Version 2.5.1 PyPI version JSON
download
home_pagehttps://github.com/DS4SD/docling
SummarySDK and CLI for parsing PDF, DOCX, HTML, and more, to a unified document representation for powering downstream workflows such as gen AI applications.
upload_time2024-11-12 14:57:46
maintainerNone
docs_urlNone
authorChristoph Auer
requires_python<4.0,>=3.10
licenseMIT
keywords docling convert document pdf docx html markdown layout model segmentation table structure table former
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <a href="https://github.com/ds4sd/docling">
    <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/docs/assets/docling_processing.png" width="100%"/>
  </a>
</p>

# Docling

<p align="center">
  <a href="https://trendshift.io/repositories/12132" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12132" alt="DS4SD%2Fdocling | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</p>

[![arXiv](https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg)](https://arxiv.org/abs/2408.09869)
[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://ds4sd.github.io/docling/)
[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/)
![Python](https://img.shields.io/badge/python-3.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/)
[![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/docling)](https://opensource.org/licenses/MIT)

Docling parses documents and exports them to the desired format with ease and speed.

## Features

* πŸ—‚οΈ Reads popular document formats (PDF, DOCX, PPTX, Images, HTML, AsciiDoc, Markdown) and exports to Markdown and JSON
* πŸ“‘ Advanced PDF document understanding including page layout, reading order & table structures
* 🧩 Unified, expressive [DoclingDocument](https://ds4sd.github.io/docling/concepts/docling_document/) representation format
* πŸ€– Easy integration with LlamaIndex πŸ¦™ & LangChain πŸ¦œπŸ”— for powerful RAG / QA applications
* πŸ” OCR support for scanned PDFs
* πŸ’» Simple and convenient CLI

Explore the [documentation](https://ds4sd.github.io/docling/) to discover plenty examples and unlock the full power of Docling!

### Coming soon

* ♾️ Equation & code extraction
* πŸ“ Metadata extraction, including title, authors, references & language
* πŸ¦œπŸ”— Native LangChain extension

## Installation

To use Docling, simply install `docling` from your package manager, e.g. pip:
```bash
pip install docling
```

Works on macOS, Linux and Windows environments. Both x86_64 and arm64 architectures.

More [detailed installation instructions](https://ds4sd.github.io/docling/installation/) are available in the docs.

## Getting started

To convert individual documents, use `convert()`, for example:

```python
from docling.document_converter import DocumentConverter

source = "https://arxiv.org/pdf/2408.09869"  # document per local path or URL
converter = DocumentConverter()
result = converter.convert(source)
print(result.document.export_to_markdown())  # output: "## Docling Technical Report[...]"
```

Check out [Getting started](https://ds4sd.github.io/docling/).
You will find lots of tuning options to leverage all the advanced capabilities.

## Get help and support

Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions).

## Technical report

For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).

## 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
@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 codebase is under MIT license.
For individual model usage, please refer to the model licenses found in the original packages.

## IBM ❀️ Open Source AI

Docling has been brought to you by IBM.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DS4SD/docling",
    "name": "docling",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "docling, convert, document, pdf, docx, html, markdown, layout model, segmentation, table structure, table former",
    "author": "Christoph Auer",
    "author_email": "cau@zurich.ibm.com",
    "download_url": "https://files.pythonhosted.org/packages/fd/dc/25a4c5e1a83dce396aef73f467a0c822de348c0d93b378a4d96840a79a49/docling-2.5.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <a href=\"https://github.com/ds4sd/docling\">\n    <img loading=\"lazy\" alt=\"Docling\" src=\"https://github.com/DS4SD/docling/raw/main/docs/assets/docling_processing.png\" width=\"100%\"/>\n  </a>\n</p>\n\n# Docling\n\n<p align=\"center\">\n  <a href=\"https://trendshift.io/repositories/12132\" target=\"_blank\"><img src=\"https://trendshift.io/api/badge/repositories/12132\" alt=\"DS4SD%2Fdocling | Trendshift\" style=\"width: 250px; height: 55px;\" width=\"250\" height=\"55\"/></a>\n</p>\n\n[![arXiv](https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg)](https://arxiv.org/abs/2408.09869)\n[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://ds4sd.github.io/docling/)\n[![PyPI version](https://img.shields.io/pypi/v/docling)](https://pypi.org/project/docling/)\n![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![License MIT](https://img.shields.io/github/license/DS4SD/docling)](https://opensource.org/licenses/MIT)\n\nDocling parses documents and exports them to the desired format with ease and speed.\n\n## Features\n\n* \ud83d\uddc2\ufe0f Reads popular document formats (PDF, DOCX, PPTX, Images, HTML, AsciiDoc, Markdown) and exports to Markdown and JSON\n* \ud83d\udcd1 Advanced PDF document understanding including page layout, reading order & table structures\n* \ud83e\udde9 Unified, expressive [DoclingDocument](https://ds4sd.github.io/docling/concepts/docling_document/) representation format\n* \ud83e\udd16 Easy integration with LlamaIndex \ud83e\udd99 & LangChain \ud83e\udd9c\ud83d\udd17 for powerful RAG / QA applications\n* \ud83d\udd0d OCR support for scanned PDFs\n* \ud83d\udcbb Simple and convenient CLI\n\nExplore the [documentation](https://ds4sd.github.io/docling/) to discover plenty examples and unlock the full power of Docling!\n\n### Coming soon\n\n* \u267e\ufe0f Equation & code extraction\n* \ud83d\udcdd Metadata extraction, including title, authors, references & language\n* \ud83e\udd9c\ud83d\udd17 Native LangChain extension\n\n## Installation\n\nTo use Docling, simply install `docling` from your package manager, e.g. pip:\n```bash\npip install docling\n```\n\nWorks on macOS, Linux and Windows environments. Both x86_64 and arm64 architectures.\n\nMore [detailed installation instructions](https://ds4sd.github.io/docling/installation/) are available in the docs.\n\n## Getting started\n\nTo convert individual documents, use `convert()`, for example:\n\n```python\nfrom docling.document_converter import DocumentConverter\n\nsource = \"https://arxiv.org/pdf/2408.09869\"  # document per local path or URL\nconverter = DocumentConverter()\nresult = converter.convert(source)\nprint(result.document.export_to_markdown())  # output: \"## Docling Technical Report[...]\"\n```\n\nCheck out [Getting started](https://ds4sd.github.io/docling/).\nYou will find lots of tuning options to leverage all the advanced capabilities.\n\n## Get help and support\n\nPlease feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions).\n\n## Technical report\n\nFor more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).\n\n## Contributing\n\nPlease read [Contributing to Docling](https://github.com/DS4SD/docling/blob/main/CONTRIBUTING.md) for details.\n\n## References\n\nIf you use Docling in your projects, please consider citing the following:\n\n```bib\n@techreport{Docling,\n  author = {Deep Search Team},\n  month = {8},\n  title = {Docling Technical Report},\n  url = {https://arxiv.org/abs/2408.09869},\n  eprint = {2408.09869},\n  doi = {10.48550/arXiv.2408.09869},\n  version = {1.0.0},\n  year = {2024}\n}\n```\n\n## License\n\nThe Docling codebase is under MIT license.\nFor individual model usage, please refer to the model licenses found in the original packages.\n\n## IBM \u2764\ufe0f Open Source AI\n\nDocling has been brought to you by IBM.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "SDK and CLI for parsing PDF, DOCX, HTML, and more, to a unified document representation for powering downstream workflows such as gen AI applications.",
    "version": "2.5.1",
    "project_urls": {
        "Homepage": "https://github.com/DS4SD/docling",
        "Repository": "https://github.com/DS4SD/docling"
    },
    "split_keywords": [
        "docling",
        " convert",
        " document",
        " pdf",
        " docx",
        " html",
        " markdown",
        " layout model",
        " segmentation",
        " table structure",
        " table former"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe30050a4371adc9f1543c7a3e36632ec08009ed13c9b77f7a4db9a94a69bf0c",
                "md5": "e52186b1ac1bc8087e469cde282f79c7",
                "sha256": "3fe936449ba5bedd73ccf02e312b42c2cec59177ad1ee02c64822ae9c50db0c8"
            },
            "downloads": -1,
            "filename": "docling-2.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e52186b1ac1bc8087e469cde282f79c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 84420,
            "upload_time": "2024-11-12T14:57:44",
            "upload_time_iso_8601": "2024-11-12T14:57:44.979568Z",
            "url": "https://files.pythonhosted.org/packages/fe/30/050a4371adc9f1543c7a3e36632ec08009ed13c9b77f7a4db9a94a69bf0c/docling-2.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fddc25a4c5e1a83dce396aef73f467a0c822de348c0d93b378a4d96840a79a49",
                "md5": "b0fc5ebc3aaf32086b221beac0397a3a",
                "sha256": "9d77af35b45f0acbdaea37900a71f33417c5ddb814166f87f2edf7d9e1d214bf"
            },
            "downloads": -1,
            "filename": "docling-2.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b0fc5ebc3aaf32086b221beac0397a3a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 65385,
            "upload_time": "2024-11-12T14:57:46",
            "upload_time_iso_8601": "2024-11-12T14:57:46.253110Z",
            "url": "https://files.pythonhosted.org/packages/fd/dc/25a4c5e1a83dce396aef73f467a0c822de348c0d93b378a4d96840a79a49/docling-2.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 14:57:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DS4SD",
    "github_project": "docling",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "docling"
}
        
Elapsed time: 0.43058s