-
Notifications
You must be signed in to change notification settings - Fork 1
/
pyproject.toml
166 lines (139 loc) · 4.54 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
154
155
156
157
158
159
160
161
162
163
164
165
166
[tool.poetry]
name = "openapi-readme"
version = "0.3.0"
description = "Generate Markdown from an openapi JSON file."
authors = ["Grant Ramsay <grant@gnramsay.com>"]
readme = "README.md"
packages = [{ include = "openapi_readme" }]
license = "MIT"
repository = "https://github.com/seapagan/openapi-readme"
homepage = "https://github.com/seapagan/openapi-readme"
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Text Processing :: Markup :: Markdown",
]
[tool.poetry.urls]
"Pull Requests" = "https://github.com/seapagan/openapi-readme/pulls"
"Bug Tracker" = "https://github.com/seapagan/openapi-readme/issues"
"Changelog" = "https://github.com/seapagan/openapi-readme/blob/main/CHANGELOG.md"
[tool.poetry.scripts]
openapi-readme = "openapi_readme.main:app"
[tool.poetry.dependencies]
python = "^3.9,<4.0"
typer = { extras = ["all"], version = ">=0.6.1,<0.13.0" }
single-source = "^0.3.0"
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
# Configure dev dependencies
[tool.poetry.group.dev.dependencies]
# linting, type-checking and security checks
mypy = "^1.8.0"
pre-commit = "^3.6.2"
pymarkdownlnt = "^0.9.12"
ruff = ">=0.3,<0.5"
# testing
faker = ">=23.3.0"
greenlet = "^3.0.3"
mock = "^5.1.0"
pyfakefs = "^5.3.5"
pytest = "^8.1.0"
pytest-cov = ">=4.1,<6.0"
pytest-xdist = "^3.5.0"
pytest-sugar = ">=1.0.0"
pytest-randomly = "^3.15.0"
pytest-reverse = "^1.7.0"
pytest-mock = "^3.12.0"
pytest-watcher = "^0.4.1"
# documentation
github-changelog-md = "^0.9.1"
# assorted utilities
poethepoet = ">=0.25.0"
[tool.poe.tasks]
# setup 'PoeThePoet' tasks
pre.cmd = "pre-commit run --all-files"
pre.help = "Run pre-commit checks"
mypy.cmd = "mypy openapi_readme/**/*.py tests/**/*.py --strict"
mypy.help = "Run mypy checks"
format.cmd = "ruff format ."
format.help = "Format code with Ruff"
ruff.cmd = "ruff check ."
ruff.help = "Run Ruff checks"
markdown.cmd = "pymarkdown scan -r openapi_readme/**/[!CHANGELOG,!.github/]*.md docs/**/*.md"
markdown.help = "Run markdown checks"
# run all linting checks in sequence. we want to run them all, even if one fails
lint.ignore_fail = "return_non_zero"
lint.sequence = ["format", "ruff", "mypy", "markdown"]
lint.help = "Run all linting checks"
# testing with pytest
test.cmd = "pytest"
test.help = "Run all tests (pytest)"
"test:watch".cmd = "ptw . --now --clear"
"test:watch".help = "Run tests using Pytest in watch mode"
# Generate a CHANGELOG.md
changelog.cmd = "github-changelog-md -r openapi-readme"
changelog.help = "Generate a CHANGELOG.md file"
# configure assorted tools and linters
[tool.pymarkdown]
plugins.md014.enabled = false
plugins.md046.enabled = false
extensions.front-matter.enabled = true
[tool.ruff]
line-length = 80
src = ["openapi_readme"]
target-version = "py39" # minimum python version supported
[tool.ruff.format]
indent-style = "space"
quote-style = "double"
[tool.ruff.lint]
select = ["ALL"] # we are being very strict!
ignore = [
"ANN101",
"PGH003",
"FBT002",
"FBT003",
"B006",
] # These rules are too strict even for us 😝
extend-ignore = ["COM812", "ISC001"] # these are ignored for ruff formatting
[tool.ruff.lint.pylint]
max-args = 6
[tool.ruff.lint.pep8-naming]
classmethod-decorators = ["pydantic.validator", "pydantic.root_validator"]
[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.ruff.lint.extend-per-file-ignores]
"tests/**/*.py" = [
"S101", # we can (and MUST!) use 'assert' in test files.
"ANN001", # annotations for fixtures are sometimes a pain for test files
"ARG002", # often fixtures are not used in test files but need to be there
]
"openapi_readme/main.py" = [
"UP007",
"PLR0913",
] # These cause issues in Typer Apps
[tool.ruff.lint.isort]
known-first-party = ["openapi_readme"]
[tool.ruff.lint.pyupgrade]
keep-runtime-typing = true
[[tool.mypy.overrides]]
disable_error_code = ["method-assign", "no-untyped-def", "attr-defined"]
module = "tests.*"
# Options for pytest and coverage
[tool.pytest.ini_options]
addopts = ["--cov", "--cov-report", "term-missing", "--cov-report", "html"]
filterwarnings = []
mock_use_standalone_module = true
markers = ["e2e: mark a test as an end-to-end test."]
[tool.coverage.run]
omit = ["*/tests/*", "openapi_readme/tree/*"]
source = ["openapi_readme"]
[tool.coverage.report]
show_missing = true