github-webhook-types/pyproject.toml at master · nicebots-xyz/github-webhook-types · 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
129
130
131
132
133
134
135
136
137
138
# SPDX-License-Identifier: ISC
# Copyright: 2026 NiceBots.xyz
[build-system]
requires = ["hatchling~=1.29.0", "hatch-vcs~=0.5.0"]
build-backend = "hatchling.build"

[project]
name = "github-webhook-types"
description = "TypedDict and Pydantic models for GitHub webhook payloads."
authors = [
    { name = "Paillat-dev", email = "me@paillat.dev" },
]
dependencies = [
    "pydantic~=2.0",
]
requires-python = ">=3.12"
readme = "README.md"
license = "ISC"
license-files = ["LICENSE"]
dynamic = ["version", "urls"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: ISC License (ISCL)",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.12",
    "Typing :: Typed",
]
keywords = ["github", "webhooks", "types", "typeddict", "pydantic"]

[dependency-groups]
dev = [
    "basedpyright~=1.39.5",
    "ruff~=0.15.13",
]
test = [
    "pytest~=9.0.3",
]
docs = [
    "mkdocstrings[python]~=1.0.3",
    "zensical~=0.0.24",
]

[tool.hatch.version]
source = "vcs"

[tool.hatch.metadata.hooks.vcs.urls]
Documentation = "https://docs.nicebots.xyz/github-webhook-types/"
Repository = "https://github.com/nicebots-xyz/github-webhook-types"
Issues = "https://github.com/nicebots-xyz/github-webhook-types/issues"
"Source Archive" = "https://github.com/nicebots-xyz/github-webhook-types/archive/{commit_hash}.zip"

[tool.hatch.build.hooks.vcs]
version-file = "src/github_webhook_types/_version.py"

[tool.hatch.build.targets.wheel]
packages = ["src/github_webhook_types"]

[tool.pdm]
distribution = true

[tool.pdm.scripts]
format = "ruff format ."
"format:check" = "ruff format --check ."
lint = "ruff check ."
typecheck = "basedpyright src tests scripts"
tests = "pytest tests"
generate = "python scripts/generate_webhook_types.py"
"generate:check" = "python scripts/generate_webhook_types.py --check"
"docs:build" = "zensical build --clean"
"docs:preview" = "python -m http.server 8000 -d site"
"docs:dev" = "zensical serve"
quality = { composite = ["format:check", "lint", "typecheck", "generate:check", "tests"] }

[tool.pyright]
venvPath = "."
venv = ".venv"
typeCheckingMode = "strict"
reportAny = false
reportUnusedCallResult = false
reportUnknownMemberType = false
reportMissingTypeStubs = false
pythonVersion = "3.12"

[[tool.pyright.executionEnvironments]]
root = "src/github_webhook_types/_version.py"
reportDeprecated = false

[tool.pytest.ini_options]
testpaths = ["tests"]
markers = [
    "network: tests that fetch live Octokit webhook data",
]

[tool.ruff]
target-version = "py312"
line-length = 120
indent-width = 4

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"
docstring-code-format = false
docstring-code-line-length = "dynamic"

[tool.ruff.lint]
select = ["ALL"]
extend-ignore = [
    "ANN401",
    "COM812",
    "D100",
    "D101",
    "D102",
    "D103",
    "D104",
    "D105",
    "D106",
    "D107",
    "D203",
    "D211",
    "D213",
    "EM101",
    "EM102",
    "ISC001",
    "PLR2004",
    "TRY003",
]

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

[tool.ruff.lint.per-file-ignores]
"scripts/**" = ["C901", "PLR0911", "S310", "S603", "T201"]
"scripts/templates/generated_module.py" = ["D415"]
"src/github_webhook_types/generated/*.py" = ["A003", "E501", "N801", "N815"]
"tests/*" = ["S101"]