template-uv-python-research-software/pyproject.toml.jinja at main · CU-DBMI/template-uv-python-research-software · 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
[build-system]
build-backend = "setuptools.build_meta"
requires = [ "setuptools>=64", "setuptools-scm>=8" ]

[project]
name = "{{ project_name }}"
dynamic = [ "version" ]
description = "{{ project_description }}"
readme = "README.md"
authors = [
  { name = "{{ author_name }}" },
]
requires-python = ">=3.11"
classifiers = [
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
]
dependencies = [
  "pandas>=2.2.3",
  "fire>=0.7.0",
  "jinja2>=3.1.6",
]
scripts.{{ project_name }} = "{{ python_package_name }}.cli:trigger"

[dependency-groups]
dev = [
  "poethepoet>=0.34",
  "pytest>=8.3.5",
  "pytest-cov>=6.2.1",
  "coverage[toml]>=7.10.6",
]
docs = [
  "myst-nb>=1.2",
  "pydata-sphinx-theme>=0.16.1",
  "sphinx>=8.2.3",
]
notebooks = [
  "black>=25.1",
  "isort>=6.0.1",
  "jupyterlab>=4.4.2",
  "jupyterlab-code-formatter>=3.0.2",
  "jupytext>=1.17.1",
]

[tool.setuptools]
package-dir = { "" = "src" }
include-package-data = true

[tool.setuptools.packages.find]
where = [ "src" ]
include = [ "{{ python_package_name }}*" ]

[tool.setuptools_scm]
root = "."
version_scheme = "no-guess-dev"
local_scheme = "no-local-version"
version_file = "src/{{ python_package_name }}/_version.py"

[tool.ruff]
target-version = "py311"
line-length = 88
fix = true
lint.select = [
  # flake8-builtins
  "A",
  # flake8-annotations
  "ANN",
  # flake8-comprehensions
  "C4",
  # mccabe
  "C90",
  # pycodestyle
  "E",
  # pyflakes
  "F",
  # isort
  "I",
  # pylint
  "PL",
  # ruff
  "RUF",
  # flake8-simplify
  "SIM",
  "W",
]
# Ignore `F401` (unused imports) for `__init__.py` file
lint.per-file-ignores."__init__.py" = [ "F401" ]

[tool.pytest.ini_options]
pythonpath = [ "." ]
addopts = [
  "--cov={{ python_package_name }}",
  "--cov-report=term-missing",
  "--cov-report=xml",
]

[tool.coverage.run]
branch = true
source = [ "src/{{ python_package_name }}" ]

[tool.coverage.report]
show_missing = true
skip_covered = true

[tool.poe.tasks]
# tasks for development environments
test.shell = """
pytest
"""
lint.shell = """
pre-commit run --all-files
"""
pipeline.shell = """
pre-commit run --all-files && pytest
"""
jupyter.shell = """
jupyter lab
"""

[tool.jupytext]
formats = "ipynb,py:light"

[tool.vulture]
min_confidence = 90
paths = [ "src/{{ python_package_name }}", "tests" ]