-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyproject.toml
161 lines (133 loc) · 4.17 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
[tool.poetry]
name = "lice2"
version = "0.12.0"
description = "Generate license files for your projects"
authors = ["Grant Ramsay <[email protected]>"]
license = "BSD"
readme = "README.md"
packages = [{ include = "lice2", from = "." }]
repository = "https://github.com/seapagan/lice2"
homepage = "https://seapagan.github.io/lice2/"
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"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",
]
[tool.poetry.urls]
"Pull Requests" = "https://github.com/seapagan/lice2/pulls"
"Bug Tracker" = "https://github.com/seapagan/lice2/issues"
"Changelog" = "https://github.com/seapagan/lice2/blob/main/CHANGELOG.md"
[tool.poetry.scripts]
lice = "lice2.core:app"
[tool.poetry.dependencies]
python = "^3.9"
rich = ">=13.7.1"
simple-toml-settings = ">=0.8.0"
typer = ">=0.12.4"
pyperclip = "^1.9.0"
single-source = "^0.4.0"
[tool.poetry.group.dev.dependencies]
# linting, type-checking and security checks
mypy = ">=1.4.1"
pre-commit = ">=3.3.3"
ruff = ">=0.6.0"
pymarkdownlnt = ">=0.9.21"
# testing
pyfakefs = ">=5.6.0"
pytest = ">=8.3.2"
pytest-clarity = "^1.0.1"
pytest-cov = ">=4,<6"
pytest-sugar = ">=0.9.7,<1.1.0"
pytest-randomly = ">=3.13.0"
pytest-reverse = ">=1.7.0"
pytest-mock = ">=3.11.1"
mock = ">=5.1.0"
poethepoet = ">=0.27.0"
# documentation
github-changelog-md = ">=0.3,<1.0.0"
mkdocs = "^1.4.3"
mkdocs-autorefs = ">=0.5,<1.3"
mkdocs-material = "^9.1.19"
mkdocs-minify-plugin = ">=0.7,<0.9"
pymdown-extensions = "^10.1"
pygments = "^2.15.1"
# changelog generation
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
[tool.poe.tasks]
pre.cmd = "pre-commit run --all-files"
pre.help = "Run pre-commit checks"
mypy.cmd = "mypy . --strict"
mypy.help = "Run mypy checks"
format.help = "Format code with Ruff"
format.cmd = "ruff format ."
ruff.help = "Run Ruff checks"
ruff.cmd = "ruff check --output-format=concise ."
changelog.cmd = "github-changelog-md"
changelog.help = "Generate a changelog"
"docs:publish".cmd = "mkdocs gh-deploy"
"docs:publish".help = "Publish documentation to GitHub Pages"
"docs:build".cmd = "mkdocs build"
"docs:build".help = "Build documentation locally to './site' folder"
"docs:serve".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md"
"docs:serve".help = "Serve documentation locally"
"docs:serve:all".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md -a 0.0.0.0:9000"
"docs:serve:all".help = "Serve documentation locally on all interfaces"
[tool.pytest.ini_options]
addopts = ["--cov", "--cov-report", "term-missing", "--cov-report", "html"]
filterwarnings = [
"ignore:pkg_resources is deprecated as an API:DeprecationWarning",
]
mock_use_standalone_module = true
[tool.coverage.run]
source = ["lice2"]
omit = ["*/tests/*"]
[tool.ruff]
line-length = 80
lint.select = ["ALL"] # we are being very strict!
lint.ignore = [
"ANN101",
"ANN102",
"PGH003",
"FBT002",
"FBT003",
"B006",
] # These rules are too strict even for us 😝
lint.extend-ignore = [
"COM812",
"ISC001",
] # these are ignored for ruff formatting
src = ["lice2"]
target-version = "py39" # minimum python version supported
[tool.ruff.format]
indent-style = "space"
quote-style = "double"
[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]
"lice2/tests/**/*.py" = [
"S101", # we can (and MUST!) use 'assert' in test files.
"ANN001", # annotations for fixtures are sometimes a pain for test files
"ARG00", # test fixtures often are not directly used
]
[tool.ruff.lint.isort]
known-first-party = ["lice2"]
[tool.ruff.lint.pyupgrade]
keep-runtime-typing = true
[tool.mypy]
python_version = "3.9"
[[tool.mypy.overrides]]
module = "pyperclip"
ignore_missing_imports = true
[[tool.mypy.overrides]]
disable_error_code = ["method-assign", "no-untyped-def", "attr-defined"]
module = "tests.*"