Skip to content

chore: Add installation instructions and fix dependencies #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikolasrieble wants to merge 3 commits into
base: main
Choose a base branch
from
+270 −248
Open

chore: Add installation instructions and fix dependencies #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93b0e93
chore: Add installation instructions and quick start guide for `uv`
nikolasrieble Nov 27, 2025
59058d1
Fix dependencies to enable 'uv run docling-eval help'
nikolasrieble Nov 27, 2025
178b143
DCO Remediation Commit for Nikolas Rieble <[email protected]>
nikolasrieble Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,39 @@ terminal %> docling-eval --help

```

## Installation

Follow the path that best matches your environment. The project targets Python 3.10–3.12; using 3.13 currently requires building native extensions from source.

### Quick start with `uv`

1. Install [uv](https://github.com/astral-sh/uv) (recommended):
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
# or: brew install uv
```
Restart your shell so `uv` is on `PATH`, then confirm with `uv --version`.
2. Sync all dependencies (runtime + dev tooling) into the project-managed `.venv`:
```bash
uv sync --all-groups
```
3. (Optional) Install extras as needed:
```bash
uv sync --group hyperscalers # AWS, Azure, Google providers
uv sync --group cvat_tools # CVAT automation utilities
```
4. Run tools through `uv run` (no manual activation needed):
```bash
uv run docling-eval --help
```

### Verify the installation

```bash
uv run docling-eval --help
uv run pytest -k layout # optional smoke test
```

## Benchmarks

- General
Expand Down
16 changes: 8 additions & 8 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ dependencies = [
"editdistance>=0.8.1",
"reportlab>=4.4.3",
"docling-parse==4.7.1",
'ibm-cos-sdk (>=2.1.40,<3.0.0)',
'boto3 (>=1.37.8,<2.0.0)',
'azure-ai-documentintelligence (>=1.0.2,<2.0.0)',
'azure-common (>=1.1.28,<2.0.0)',
'azure-core (>=1.33.0,<2.0.0)',
'google-cloud-documentai (>=3.2.0,<4.0.0)',
]

[project.urls]
Expand All @@ -66,15 +72,9 @@ changelog = "https://github.com/docling-project/docling-eval/blob/main/CHANGELOG
[project.scripts]
docling-eval = "docling_eval.cli.main:app"

# optional extras kept for compatibility; currently no additional deps required
[project.optional-dependencies]
hyperscalers = [
'azure-ai-documentintelligence (>=1.0.2,<2.0.0)',
'azure-common (>=1.1.28,<2.0.0)',
'azure-core (>=1.33.0,<2.0.0)',
'boto3 (>=1.37.8,<2.0.0)',
'google-cloud-documentai (>=3.2.0,<4.0.0)',
'ibm-cos-sdk (>=2.1.40,<3.0.0)',
]
hyperscalers = []
cvat_tools = [
"cvat-sdk>=2.40.0",
'ocrmac>=1.0.0; sys_platform == "darwin" and platform_machine == "arm64"',
Expand Down
Loading