cmi-docx/pyproject.toml at main · childmindresearch/cmi-docx · 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
[project]
name = "cmi-docx"
version = "0.6.14"
description = "Additional tooling for Python-docx."
readme = "README.md"
requires-python = ">=3.12"
dependencies = ["lxml>=6.0.2", "python-docx>=1.1.2"]

[dependency-groups]
dev = [
    "pytest>=8.3.4",
    "pytest-cov>=6.0.0",
    "pdoc>=15.0.1",
    "ty>=0.0.25",
    "prek>=0.3.8",
    "ruff>=0.15.7",
    "pytest-asyncio>=1.3.0",
]

[tool.hatch.build.targets.wheel]
packages = ["src/cmi_docx"]

[tool.pytest.ini_options]
pythonpath = ["src"]
testpaths = ["tests"]

[tool.mypy]
ignore_missing_imports = true

[tool.ruff]
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]
line-length = 88
indent-width = 4
src = ["src"]
target-version = "py312"

[tool.ruff.lint]
preview = false
select = ["ALL"]
ignore = [
    "PYI063", # Preview rule not correctly ignored.
    "SIM300", # Can cause mypy issues in SQLAlchemy where statements.
    # Recommended ignores by Astral https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules)
    "W191",   # Tab indentation
    "E111",   # Indentation with invalid multiple
    "E114",   # Indentation with invalid multiple comment
    "E117",   # Over indented
    "D206",   # Docstring tab indentation
    "D300",   # Triple single quotes
    "Q000",   # Bad quotes inline string
    "Q001",   # Bad quotes multiline string
    "Q002",   # Bad quotes docstring
    "Q003",   # Avoidable escaped quote
    "COM812", # Missing trailing comma
    "COM819", # Prohibited trailing comma
    "ISC002", # Multi-line implicit string concatenation
]
fixable = ["ALL"]
unfixable = []
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

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

[tool.ruff.lint.per-file-ignores]
"tests/**/*.py" = [
    "S101",   # asserts should be used in pytest
    "SLF001", # accessing private members in tests is fine
    "INP001", # tests should not be a module
    "ARG001", # tests can have ununsed arguments (fixtures with side-effects)
]
"local/**/*" = ["ALL"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"