pyconify/pyproject.toml at main · pyapp-kit/pyconify · 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
# https://peps.python.org/pep-0517/
[build-system]
requires = ["hatchling>=1.27", "hatch-vcs"]
build-backend = "hatchling.build"

# https://hatch.pypa.io/latest/config/metadata/
[tool.hatch.version]
source = "vcs"

# https://peps.python.org/pep-0621/
[project]
name = "pyconify"
dynamic = ["version"]
description = "iconify for python. Universal icon framework"
readme = "README.md"
requires-python = ">=3.11"
# https://peps.python.org/pep-0639/
license = "BSD-3-Clause"
license-files = ["LICENSE"]
authors = [{ name = "Talley Lambert", email = "talley.lambert@gmail.com" }]
# https://pypi.org/classifiers/
classifiers = [
    "Development Status :: 4 - Beta",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: 3.15",
    "Typing :: Typed",
]
dependencies = ["requests>=2.30"]

[project.urls]
homepage = "https://github.com/pyapp-kit/pyconify"
repository = "https://github.com/pyapp-kit/pyconify"

# https://peps.python.org/pep-0735/
# setup with `uv sync` or `pip install -e . --group dev`
[dependency-groups]
test = ["pytest>=9.0", "pytest-cov>=7.0"]
dev = [
    { include-group = "test" },
    "ipython>=9.0",
    "prek>=0.5",  # https://prek.j178.dev/
    "rich>=14.0",
    "ruff>=0.17",
    "ty>=0.0.92",
    "types-requests>=2.32",
]

# https://docs.astral.sh/ruff
[tool.ruff]
line-length = 88
src = ["src", "tests"]

[tool.ruff.lint]
pydocstyle = { convention = "numpy" }
# ruff's default rule set is already extensive (F, E7/E9, B, UP, C4, SIM, PERF,
# PTH, FURB, RUF, ...). See https://docs.astral.sh/ruff/default-rules/
# the following are added on top of the defaults.
extend-select = [
    "E",    # style errors
    "W",    # style warnings
    "F",    # flakes
    "D",    # pydocstyle
    "D417", # Missing argument descriptions in Docstrings
    "I",    # isort
    "UP",   # pyupgrade
    "S",    # bandit
    "C4",   # flake8-comprehensions
    "B",    # flake8-bugbear
    "A001", # flake8-builtins
    "ANN",  # flake8-annotations (replaces mypy's disallow_untyped_defs)
    "TC",   # flake8-type-checking
    "TID",  # flake8-tidy-imports
    "RUF",  # ruff-specific rules
    "PERF", # performance
    "SLF",  # private access
]
ignore = [
    "D100",   # Missing docstring in public module
    "D401",   # First line should be in imperative mood (remove to opt in)
    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
]

[tool.ruff.lint.per-file-ignores]
"tests/*.py" = ["D", "S101", "E501", "SLF"]

# https://docs.astral.sh/ruff/formatter/
[tool.ruff.format]
docstring-code-format = true
skip-magic-trailing-comma = false  # default is false

# https://docs.pytest.org/en/stable/reference/customize.html#pyproject-toml
[tool.pytest]
minversion = "9.0"
addopts = ["--color=yes"]
testpaths = ["tests"]
filterwarnings = ["error"]

# https://docs.astral.sh/ty/reference/configuration/
[tool.ty.environment]
root = ["./src"]

[tool.ty.terminal]
error-on-warning = true

# https://coverage.readthedocs.io/
[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "if TYPE_CHECKING:",
    "@overload",
    "except ImportError",
    "raise AssertionError",
    "\\.\\.\\.",
    "raise NotImplementedError()",
]

[tool.coverage.run]
source = ["pyconify"]

# https://github.com/crate-ci/typos/blob/master/docs/reference.md
[tool.typos.default]
extend-ignore-identifiers-re = []