pyversity/pyproject.toml at main · Pringled/pyversity · 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
[project]
name = "pyversity"
description = "Fast Diversification for Search & Retrieval"
readme = { file = "README.md", content-type = "text/markdown" }
license = { file = "LICENSE" }
requires-python = ">=3.10"
authors = [{ name = "Thomas van Dongen", email = "thomas123@live.nl" }]
dynamic = ["version"]

classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Software Development :: Libraries",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Natural Language :: English",
]

dependencies = [
    "numpy"
]

[project.urls]
"Homepage" = "https://github.com/Pringled/pyversity"
"Bug Reports" = "https://github.com/Pringled/pyversity/issues"
"Source" = "https://github.com/Pringled/pyversity"

[build-system]
requires = ["setuptools>=64"]
build-backend = "setuptools.build_meta"

[project.optional-dependencies]
dev = [
    "ipython",
    "mypy",
    "pre-commit",
    "pytest",
    "pytest-codeblock",
    "pytest-cov",
    "ruff",
    "types-requests",
]
benchmarks = [
    "datasets~=3.6.0",
    "huggingface-hub~=0.30.0",
    "matplotlib~=3.10.0",
    "pandas~=2.3.0",
    "requests~=2.32.0",
    "scikit-learn>=1.6.0",
    "scipy>=1.13.0",
    "seaborn~=0.13.0",
    "tqdm~=4.67.0",
]

[tool.ruff]
exclude = [".venv/"]
line-length = 120
target-version = "py310"

[tool.ruff.lint]
select = [
    # Annotations: Enforce type annotations
    "ANN",
    # Complexity: Enforce a maximum cyclomatic complexity
    "C90",
    # Pydocstyle: Enforce docstrings
    "D",
    # Remove unused imports
    "F",
    # Isort: Enforce import order
    "I",
    # Numpy: Enforce numpy style
    "NPY",
    # Print: Forbid print statements
    "T20",
]
ignore = [
    # Allow self and cls to be untyped, and allow Any type
    "ANN101", "ANN102", "ANN401",
    # Pydocstyle ignores
    "D100", "D101", "D104", "D203", "D212", "D401",
    # Allow use of f-strings in logging
    "G004"
]

[tool.pydoclint]
style = "sphinx"
exclude = "test_"
allow-init-docstring = true
arg-type-hints-in-docstring = false
check-return-types = false
require-return-section-when-returning-nothing = false

[tool.mypy]
python_version = "3.10"
warn_unused_configs = true
ignore_missing_imports = true

[tool.setuptools]
package-dir = {"" = "src"}
license-files = ["LICENSE*"]

[tool.setuptools.packages.find]
where = ["src"]
include = ["pyversity*"]

[tool.setuptools.package-data]
pyversity = ["py.typed"]

[tool.setuptools.dynamic]
version = {attr = "pyversity.version.__version__"}

[tool.pytest.ini_options]
addopts = [
    "-ra",
    "-vvv",
    "-q",
    "-p", "tests.docs_conftest",
    "--cov=pyversity",
    "--cov=benchmarks",
    "--cov-report=html",
    "--cov-report=term-missing",
    "--cov-append",
    "--capture=no",
]
pythonpath = ["src", "."]
norecursedirs = [".git"]

[tool.coverage.run]
relative_files = true
omit = ["benchmarks/*"]
source = ["pyversity"]

[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "@overload",
]

[tool.pytest-codeblock]
test_nameless_codeblocks = true