template_python_paper/pyproject.toml at main · LouieSlocombe/template_python_paper · 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
[build-system]
requires = ["setuptools>=84.0.0"]
build-backend = "setuptools.build_meta"

[project]
name = "template-python"
version = "0.1.0"
description = "A modern, reproducible Python project template for research and papers."
readme = "README.md"
requires-python = ">=3.12"
license = "MIT"
license-files = ["LICENSE"]
authors = [
  { name = "Louie Slocombe", email = "louies@hotmail.co.uk" },
]
keywords = ["python", "reproducibility", "research", "template"]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Intended Audience :: Science/Research",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Scientific/Engineering",
  "Typing :: Typed",
]
dependencies = [
  "numpy>=2.5.3",
]

[dependency-groups]
analysis = [
  "ipykernel>=7.3.0",
  "jupyterlab>=4.6.4",
  "matplotlib>=3.11.2",
  "pandas>=3.0.6",
  "scipy>=1.18.1",
]
build = [
  "build>=1.6.1",
  "twine>=7.0.0",
]
quality = [
  "mypy>=2.3.1",
  "pre-commit>=4.6.2",
  "ruff>=0.16.9",
]
test = [
  "pytest>=9.1.1",
  "pytest-cov>=7.1.0",
]
dev = [
  { include-group = "build" },
  { include-group = "quality" },
  { include-group = "test" },
]

[project.scripts]
template-python = "template_python.cli:main"

[project.urls]
Homepage = "https://github.com/LouieSlocombe/template_python_paper"
Issues = "https://github.com/LouieSlocombe/template_python_paper/issues"
Repository = "https://github.com/LouieSlocombe/template_python_paper"

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

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

[tool.pytest.ini_options]
addopts = ["--strict-config", "--strict-markers", "-ra"]
testpaths = ["tests"]
xfail_strict = true

[tool.coverage.run]
branch = true
source = ["template_python"]

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

[tool.mypy]
python_version = "3.12"
strict = true
warn_unreachable = true

[tool.ruff]
line-length = 88
src = [".", "tests"]
target-version = "py312"

[tool.ruff.lint]
select = ["B", "E4", "E7", "E9", "F", "I", "NPY", "RUF", "SIM", "UP"]

[tool.ruff.lint.isort]
known-first-party = ["template_python"]