docs/pyproject.toml at main · MrTalecky/docs · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
[project]
name = "docs-monorepo"
version = "0.1.0"
description = "Consolidated LangChain documentation monorepo"
readme = "README.md"
requires-python = ">=3.13.0,<4.0.0"
dependencies = [
    "watchdog>=3.0.0",
    "tqdm>=4.66.0",
    "nbformat>=5.0.0",
    "pyyaml>=6.0.2",
    "nbconvert>=7.16.6",
    "langchain>=1.0.1",
    "langchain-anthropic>=1.0.0",
    "langgraph-checkpoint-postgres",
    "psycopg[binary,pool]>=3.2.0",
]


[dependency-groups]
test = [
    "requests",
    "ruamel-yaml>=0.18.15",
    "ty>=0.0.23,<1.0.0",
    "ruff>=0.13.0,<1.0.0",
    "pytest>=8.3.4",
    "pytest-asyncio>=0.25.3",
    "pytest-cov>=6.0.0",
    "pytest-mock>=3.14.0",
    "pytest-socket>=0.7.0",
    "pytest-timeout>=2.3.1",
]


[project.scripts]
docs = "pipeline.cli:main"


[project.urls]
repository = "https://github.com/langchain-ai/docs"


[tool.setuptools]
packages = ["pipeline"]


[tool.uv]
package = true
override-dependencies = [
    "pytest-codspeed>=3.1.0,<4.0.0",
]


[tool.pytest.ini_options]
minversion = "8.0"
# -ra: Report all extra test outcomes (passed, skipped, failed, etc.)
# -q: Enable quiet mode for less cluttered output
# -v: Enable verbose output to display detailed test names and statuses
# --durations=5: Show the 10 slowest tests after the run (useful for performance tuning)
addopts = "-ra -q -v --durations=5"
testpaths = [
    "tests",
]
python_files = ["test_*.py"]
python_functions = ["test_*"]
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"


[tool.codespell]
ignore-words = "src/.codespellignore"
skip = "**/document_loaders/image_captions.mdx,**/integrations/llms/google_vertex_ai.mdx,src/oss/python/integrations/tools/nvidia_riva.mdx"
uri-ignore-words-list = "*"

[tool.ruff]
line-length = 88
extend-exclude = [
    "scripts/update_mdx.py",
    "pipeline/tools/notebook/convert.py"
]


[tool.ruff.lint]
select = [
    "ALL",
]

ignore = [
    "COM812",
    "C901",
    "PLR0915",
    "PLR0912"
]


[tool.ruff.lint.extend-per-file-ignores]

".github/**/*.py" = []

"pipeline/**/*.py" = [
    "TD002",  # Comments are fine
    "TD003",  # Comments are fine
    "FIX002", # Comments are fine
    "D103",   # Missing docstring in simple function
]

"reference/python/**/*.py" = [
    "T201",  # Print statements
]

"pipeline/preprocessors/link_map.py" = [
    "E501",  # Line length
]

"tests/**/*.py" = [
    "S101", # asserts allowed in tests...
    "ARG", # Unused function args -> fixtures nevertheless are functionally relevant...
    "FBT", # Don't care about booleans as positional arguments in tests, e.g. via @pytest.mark.parametrize()
    "D104",

    # The below are debatable
    "PLR2004", # Magic value used in comparison, ...
    "S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
    "SLF001", # OK to access private members in unit tests!
    "W291", # Test files may have trailing whitespace intentionally
    "W293", # Test files may have blank lines with whitespace intentionally
]

"scripts/**/*.py" = [
    "INP001",  # Not a package
    "T201",    # Print statements
    "PLW2901", # Overwriting loop variable is intentional
    "ANN",     # Type annotations
    "FBT002",  # Boolean defaults are fine
    "D103",    # Missing docstring in public function
    "E501",    # Line too long (user-facing messages)
    "EXE001",  # Shebang without executable bit
    "PLR2004", # Magic values in comparisons
    "PTH123",  # open() vs Path.open()
    "S603",    # subprocess call
    "S607",    # Partial executable path
    "SIM102",  # Collapsible if statements
]

"src/code-samples/**/*.py" = [
    "INP001",  # Not a package
    "D100",    # Module docstring
    "D101",    # Class docstring
    "D103",    # Function docstring
    "S101",    # Assert in sample verification
    "T201",    # Print statements
    "B007",    # Unused loop variable
]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ty.src]
exclude = [
    "src/code-samples/",
]

[tool.ty.rules]
invalid-method-override = "ignore"  # nbconvert subclass parameter name mismatches