kloppy/pyproject.toml at master · PySport/kloppy · 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
# ━━━━━━━━━━━━━━━━━━━━━━━━━━ Build System ━━━━━━━━━━━━━━━━━━━━━━━━━━ #

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

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Project ━━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[project]
name = "kloppy"
version = "3.17.0"
description = "Soccer Data Processing, Simplified"
readme = { file = "README.md", content-type = "text/markdown" }
license = { file = "LICENSE" }
authors = [
    { name = "Koen Vossen", email = "info@koenvossen.nl" }
]
keywords = ["soccer", "tracking data", "event data", "sports analytics"]
classifiers = [
    "Topic :: Scientific/Engineering",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "License :: OSI Approved :: BSD License",
]

# ━━━━━━━━━━━━━━━━━━━━━━ Primary Dependencies ━━━━━━━━━━━━━━━━━━━━━━ #

requires-python = ">=3.9"
dependencies = [
    "lxml>=4.4.0",
    "typing_extensions; python_version < '3.11'",
    "sortedcontainers>=2",
    "fsspec[http]>=2024.12.0",
    "pytz>=2025.2",
    "python-dateutil>=2.9.0.post0",
]

[project.optional-dependencies]
query = ["networkx>=2.4,<3"]
s3 = [ "fsspec[s3]" ]
pandas = [ "pandas>=2.0.3" ]
polars = [ "polars>=0.16.6" ]
pyarrow = [ "pyarrow>=17.0.0" ]

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Scripts ━━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[project.scripts]
kloppy-query = "kloppy.cmdline:run_query"

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━ PyPi URLS ━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[project.urls]
Repository = "https://github.com/PySport/kloppy"
Documentation = "https://kloppy.pysport.org/"

# ━━━━━━━━━━━━━━━━━━━━━━━ Extra Dependencies ━━━━━━━━━━━━━━━━━━━━━━━ #

[dependency-groups]
dev = [
    "ruff",                              # Python formatter
    "pytest>=6.2.5,<8",                  # Testing framework
    "pytest-lazy-fixture>=0.6.3",        # Use fixtures as parameters in pytest
    "pytest-httpserver",                 # Mock HTTP server for testing
    "moto[s3,server]",                   # Mock AWS S3 for testing
    "pre-commit>=4.2.0",                 # Git hooks for code quality checks
]

docs = [
    "mkdocs>=1.6.1",                     # Documentation generator
    "mkdocs-material>=9.5.44",           # Material design theme for MkDocs
    "mkdocs-material-extensions==1.3.1", # Extra features for MkDocs Material theme
    "mkdocstrings-python==1.12.2",       # Auto-generate API docs from Python docstrings
    "griffe-generics==1.0.13",           # Extension for parsing types in docs
    "markdown-exec[ansi]>=1.10.3",       # Run and render code blocks in Markdown
    "mkdocs-autorefs==1.2.0",            # Automatic cross-referencing for MkDocs
    "mkdocs-exclude==1.0.2",             # Exclude files/folders from MkDocs builds
    "mkdocs-jupyter==0.24.7",            # Embed Jupyter notebooks in MkDocs
    "mkdocs-macros-plugin>=1.0.7",       # Template macros for MkDocs
    "mplsoccer==1.3.0",                  # Soccer plotting package (used in docs)
    "pandas[output-formatting]>=2.2.3",  # Output formatting for dataframes
]

nb = [
    "ipykernel>=6.29.5",                 # Jupyter kernel runtime environment
]

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ uv ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[tool.uv]
package = true
default-groups = ["dev", "docs", "nb"]

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Ruff ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[tool.ruff]
target-version = "py39"
line-length = 80  # use whatever number makes you happy
format = { quote-style = "double", indent-style = "space" }
exclude = [
    "examples",
    "docs/presentations",
]

[tool.ruff.lint]
# TODO: starting with a limited set of rules, but we'll probably add more later
# you can see the looong list of rules here: https://docs.astral.sh/ruff/rules/
# select = ["ALL"]
select = [
    "A",    # warn about shadowing built-ins
    "E",    # style stuff, whitespaces
    "F",    # important pyflakes lints
    "I",    # import sorting
    "UP",   # pyupgrade
    "T100", # breakpoints (probably don't want these in prod!)
]
ignore = [
    "E501",  # line too long
    "E731",  # do not assign a lambda expression, use a def
    "A005",  # do not shadow a Python standard library module
]

mccabe.max-complexity = 10
pycodestyle.max-doc-length = 99
pydocstyle.convention = "google"
isort = { known-first-party = ["kloppy"], force-sort-within-sections = true }

[tool.ruff.lint.per-file-ignores]
"kloppy/**/__init__.py" = [
    "F401",  # Allow unused imports in __init__.py
    "F403",  # Allow redefinition of 'from ... import *' in __init__.py
]
"kloppy/event_pattern_matching.py" = [
    "F403",  # Allow redefinition of 'from ... import *' in event_pattern_matching.py
]

# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Pytest ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ #

[tool.pytest.ini_options]
testpaths = ["kloppy/tests"]
addopts = "--tb=long --code-highlight=yes --doctest-modules"