1+ # Docling Core
2+
13[ ![ PyPI version] ( https://img.shields.io/pypi/v/docling-core )] ( https://pypi.org/project/docling-core/ )
2- ![ Python] ( https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue )
4+ ![ Python] ( https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12 -blue )
35[ ![ Poetry] ( https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json )] ( https://python-poetry.org/ )
46[ ![ Code style: black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github.com/psf/black )
57[ ![ Imports: isort] ( https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 )] ( https://pycqa.github.io/isort/ )
68[ ![ Checked with mypy] ( https://www.mypy-lang.org/static/mypy_badge.svg )] ( https://mypy-lang.org/ )
79[ ![ Pydantic v2] ( https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json )] ( https://pydantic.dev )
810[ ![ pre-commit] ( https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white )] ( https://github.com/pre-commit/pre-commit )
9- [ ![ License MIT] ( https://img.shields.io/github/license/ds4sd/deepsearch-toolkit )] ( https://opensource.org/licenses/MIT )
10-
11- # Docling Core
11+ [ ![ License MIT] ( https://img.shields.io/github/license/ds4sd/docling-core )] ( https://opensource.org/licenses/MIT )
1212
1313Docling Core is a library that defines the data types in [ Docling] ( https://ds4sd.github.io ) , leveraging pydantic models.
1414
1515## Installation
1616
17- Using [ Poetry] ( https://python-poetry.org ) , create and activate a virtual environment.
18-
19- ```
20- poetry shell
17+ To use Docling Core, simply install ` docling-core ` from your package manager, e.g. pip:
18+ ``` bash
19+ pip install docling-core
2120```
2221
23- Install the defined dependencies of the project.
22+ ### Development setup
2423
25- ```
24+ 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:
25+ ``` bash
2626poetry install
2727```
2828
29- Test the installation running the pytest suite.
30-
29+ To run the pytest suite, execute:
3130```
3231poetry run pytest test
3332```
@@ -77,7 +76,7 @@ Please read [Contributing to Docling Core](./CONTRIBUTING.md) for details.
7776
7877## References
7978
80- If you use ` Docling Core ` in your projects, please consider citing the following:
79+ If you use Docling Core in your projects, please consider citing the following:
8180
8281``` bib
8382@software{Docling,
@@ -92,5 +91,5 @@ year = {2024}
9291
9392## License
9493
95- The ` Docling Core ` codebase is under MIT license.
94+ The Docling Core codebase is under MIT license.
9695For individual model usage, please refer to the model licenses found in the original packages.
0 commit comments