FORetrieval/pyproject.toml at main · FOR-sight-ai/FORetrieval · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
include = ["foretrieval*"]

[project]
name = "FORetrieval"
version = "0.1"
description = "Use late-interaction multi-modal models such as ColPali in just a few lines of code."
readme = "README.md"
requires-python = ">=3.12"
license = { file = "LICENSE" }
keywords = [
    "reranking",
    "retrieval",
    "rag",
    "nlp",
    "colpali",
    "colbert",
    "multi-modal",
]
authors = [{ name = "The FOR team", email = "for@irt-saintexupery.com" }]

dependencies = [
    "colpali-engine>=0.3.15,<0.4.0",
    "httpx>=0.27.0",
    "docx2pdf>=0.1.8",
    "langdetect>=1.0.9",
    "ml-dtypes",
    "pydantic-ai>=1.4.0",
    "pydantic-ai-slim[openai]>=1.8.0",
    "pypdf>=6.1.3",
    "srsly",
    "torch>=2.7.1",
    "transformers>=4.42.0,<5.6.0",
    "pdf2image>=1.17.0",
]

[project.optional-dependencies]
# Qdrant vector-store backend (recommended for large indexes)
qdrant = ["qdrant-client>=1.17.1"]
# Docling-based PDF chunking ingestion pipeline
docling = ["docling>=2.76.0"]
embedding_server = ["paramiko>=3.0"]
# 4-bit / 8-bit quantization for local ColPaliModel (requires CUDA)
quantization = ["bitsandbytes>=0.42.0"]
dev = ["pytest>=7.4.0", "pytest-mock>=3.0", "ruff>=0.1.9"]
langchain = ["langchain-core"]
extra_converters = [
    "docx2pdf>=0.1.8; sys_platform == \"win32\"",
    "reportlab>=4.4.4",
    "python-docx>=1.2.0",
    "python-pptx>=1.0.2",
]

[project.urls]
"Homepage" = "https://github.com/FOR-sight-ai/FORetrieval"

[dependency-groups]
dev = [
    "matplotlib>=3.10.8",
]

[tool.pytest.ini_options]
filterwarnings = ["ignore::Warning"]
markers = [
    "slow: marks test as slow (GPU-dependent or expensive)",
    "integration: marks test as requiring a live API key",
]
testpaths = ["tests"]

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "*.ipynb",
    "examples",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]

# Same as Black.
line-length = 88
output-format = "grouped"

target-version = "py312"

[tool.ruff.lint]
select = [
    # bugbear rules
    "B",
    "I",
    # remove unused imports
    "F401",
    # bare except statements
    "E722",
    # unused arguments
    "ARG",
]
ignore = ["B006", "B018"]

unfixable = ["T201", "T203"]
ignore-init-module-imports = true