python-template/pyproject.toml at main · evmckinney9/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
[build-system]
requires = ["setuptools", "wheel", "setuptools_rust"]
build-backend = "setuptools.build_meta"

[project]
name = "{{project_name}}"
description = "{{project_description}}"
version = "0.1.0"
authors = [{ name = "{{author_name}}" }]
license = { text = "MIT" }
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
    "numpy",
    "matplotlib",
    "LovelyPlots",
]

[project.urls]
Homepage = "https://github.com/{{github_username}}/{{project_name}}"
Repository = "https://github.com/{{github_username}}/{{project_name}}"
Issues = "https://github.com/{{github_username}}/{{project_name}}/issues"

[project.optional-dependencies]
format = ["pre-commit", "ruff"]
test = ["pytest"]
docs = [
    "sphinx",
    "furo",
    "nbsphinx",
    "ipykernel",
    "pypandoc_binary", # bundles the pandoc binary nbsphinx needs
]
dev = [
    "{{project_name}}[format,test,docs]",
    "pylatexenc",
    "ipywidgets",
]

[tool.ruff]
target-version = "py312"
fix = true
extend-include = ["*.ipynb"]

[tool.ruff.lint]
select = ["D", "ANN"]
ignore = [
    "D105",   # magic methods like __init__ don't need docstrings
    "ANN401", # Any is legitimate at FFI / numpy seams
    "ANN002", # *args doesn't need type annotations
    "ANN003", # **kwargs doesn't need type annotations
]

[tool.ruff.lint.per-file-ignores]
"scripts/**" = ["D", "ANN"]
"src/tests/**/*.py" = ["D1", "ANN"]
"**/*.ipynb" = ["D", "ANN"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[[tool.setuptools-rust.ext-modules]]
# Private Rust extension module nested into the Python package
# https://github.com/PyO3/setuptools-rust
target = "{{project_name}}._accelerate"
path = "crates/Cargo.toml"
binding = "PyO3"
debug = false

[tool.distutils.bdist_wheel]
py_limited_api = "cp310"