Python-Template/pyproject.toml at main · CCPBioSim/Python-Template · 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
[build-system]
requires = ["flit_core>=3.4,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "example_package"
dynamic = ["version"]

description = "Short description of your package"
authors = [
    { name = "Your Name", email = "you@example.com" },
]
maintainers = [
    { name = "Your Name", email = "you@example.com" }
]

readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.12"

classifiers = [
    "Development Status :: 3 - Alpha",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Intended Audience :: Science/Research",
    "Operating System :: OS Independent",
    "Topic :: Software Development :: Libraries",
]

keywords = ["template", "python", "package"]

dependencies = [
    # Add runtime dependencies here (empty for template)
]

[project.urls]
Homepage = "https://github.com/CCPBioSim/Python-Template/"
Repository = "https://github.com/CCPBioSim/Python-Template.git"
Documentation = "https://Python-Template.github.io/"

#
# Optional dependency groups
#

[project.optional-dependencies]
testing = [
    "pytest>=9.0,<10.0",
    "pytest-cov>=7.0,<8.0",
    "pytest-sugar>=1.1,<2.0"
]

pre-commit = [
    "ruff>=0.14.8",
    "pre-commit>=4.5,<5.0",
    "pylint>=4.0,<5.0"
]

docs = [
    "sphinx>=9,<10",
    "nbsphinx>=0.9,<1.0",
    "sphinx_rtd_theme>=3,<3.2",
    "sphinx_copybutton>=0.5,<1.0",
    "sphinxcontrib-contentui>=0.2,<1.0",
    "sphinxcontrib-details-directive>=0.1,<1.0",
    "furo>=2025.0,<2026.0",
    "markupsafe>=3.0,<4.0"
]

# Run `example-cli` mapped to a Python function
[project.scripts]
# example-cli = "example_package.cli:main"  # Uncomment and modify if you add CLI scripts

#
# Ruff configuration inside pyproject (recommended)
#

[tool.ruff]
line-length = 88
target-version = "py312"
fix = true
exclude = ["docs/*", "build/*"]

[tool.ruff.lint]
select = ["E", "F", "W", "I"]   # base checks + import sort
ignore = ["E501"]              # override if long lines ok (depends on preference)
fixable = ["ALL"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
docstring-code-format = true

#
# Pytest configuration
#

[tool.pytest.ini_options]
minversion = "9.0"
addopts = "--cov=example_package --cov-report=term-missing"
testpaths = ["tests"]