-
Notifications
You must be signed in to change notification settings - Fork 1
/
pyproject.toml
153 lines (136 loc) · 4.08 KB
/
pyproject.toml
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
[project]
name = "yapper"
version = "0.5.0"
description = "Parser for converting python docstrings to .astro files for the Astro static site generator."
readme = 'README.md'
requires-python = ">=3.8,<4.0"
license = { text = "MIT" }
keywords = [
'python',
'static-site-generator',
'astro',
'parser',
'documentation',
'docstrings',
]
authors = [{ name = "Gareth Simons", email = "[email protected]" }]
maintainers = [{ name = "Gareth Simons", email = "[email protected]" }]
classifiers = ["Programming Language :: Python"]
dependencies = [
"dominate<3.0.0,>=2.6.0",
"python-slugify<7.0.0,>=6.1.1",
"Markdown<4.0.0,>=3.3.6",
"toml>=0.10.2",
"griffe>=0.25.2",
]
[project.scripts]
yapper = "yapper.cli:parse_cli"
[tool.pdm]
[tool.pdm.dev-dependencies]
dev = [
"pytest>=7.1.1",
"setuptools-scm>=6.4.2",
"pylint>=2.13.7",
"black>=22.3.0",
"isort>=5.10.1",
"pydocstyle>=6.1.1",
"types-python-slugify>=5.0.4",
"types-toml>=0.10.7",
"pyright>=1.1.246",
"setuptools>=62.3.2",
"twine>=4.0.0",
"coverage>=6.4.1",
"markdown-it-py>=3.0.0",
"linkify-it-py>=2.0.2",
"mdit-py-plugins>=0.4.0",
]
[tool.pdm.scripts]
formatting = { shell = "black --config=pyproject.toml ./ && isort --settings-file=pyproject.toml ./" }
linting = "pylint --rcfile=pyproject.toml ./yapper"
typechecks = "pyright"
docstyle = "pydocstyle --config=pyproject.toml"
tests = "pytest ./tests"
coverage_run = "coverage run -m pytest ./tests"
coverage_report = { shell = "coverage report --show-missing --skip-empty && coverage lcov" }
build_project = { shell = "pdm run formatting && pdm run linting && pdm run typechecks && pdm run docstyle && pdm run tests && pdm build" }
[project.urls]
homepage = "https://github.com/benchmark-urbanism/yapper"
documentation = "https://github.com/benchmark-urbanism/yapper"
repository = "https://github.com/benchmark-urbanism/yapper"
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"
[tool.setuptools]
packages = ["yapper"]
[tool.black]
line-length = 120
color = true
[tool.pylint.master]
disable = [
"too-many-branches",
"too-many-statements",
"too-many-locals",
"missing-module-docstring",
"logging-fstring-interpolation",
"unspecified-encoding",
]
jobs = 0
output-format = "colorized"
[tool.pylint.basic]
good-names = ["a", "h", "i", "j", "s", "md"]
[tool.pylint.design]
max-args = 10
[tool.pylint.format]
max-line-length = 120
[tool.pyright]
pythonVersion = '3.10'
include = ["yapper"]
exclude = [
"**/node_modules",
"**/__pycache__",
"__pypackages__",
"yapper/stubs",
]
typeCheckingMode = "strict"
stubPath = "yapper/stubs"
useLibraryCodeForTypes = true
reportMissingTypeStubs = true
[tool.isort]
profile = "black"
skip_gitignore = true
line_length = 120
known_first_party = ["yapper"]
atomic = true
filter_files = true
src_paths = ["yapper", "tests"]
[tool.pytest.ini_options]
console_output_style = "count"
log_cli = true
log_cli_level = "INFO"
testpaths = ["tests"]
[tool.coverage.run]
source = ["yapper"]
branch = true
omit = ["**/__init__.py"]
[tool.coverage.report]
include = ["yapper/**"]
omit = ["**/__init__.py"]
[tool.pydocstyle]
# http://www.pydocstyle.org/en/stable/error_codes.html
ignore = [
"D100", # Missing docstring in public module
"D200", # One-line docstring should fit on one line with quotes
"D203", # 1 blank line required before class docstring
"D212", # Multi-line docstring summary should start at the first line
]
match = "(?!test_).*\\.py"
match_dir = "^(?!(__pypackages__|build|tests|.venv)).*"
[tool.pdm.scripts]
formatting = { shell = "black --config=pyproject.toml ./ && isort --settings-file=pyproject.toml ./" }
linting = "pylint --rcfile=pyproject.toml ./yapper"
typechecks = "pyright"
docstyle = "pydocstyle --config=pyproject.toml"
tests = "pytest ./tests"
coverage_run = "coverage run -m pytest ./tests"
coverage_report = { shell = "coverage report --show-missing --skip-empty && coverage lcov" }
build_project = { shell = "pdm run formatting && pdm run linting && pdm run typechecks && pdm run docstyle && pdm run tests && pdm build" }