forked from nautobot/cookiecutter-nautobot-app
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpyproject.toml
101 lines (88 loc) · 2.66 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
[tool.poetry]
name = "cookiecutter-nautobot-app"
package-mode = false
description = "Cookiecutter template for baking Nautobot App cookies."
authors = ["Network to Code, LLC <[email protected]>"]
readme = "README.md"
repository = "https://github.com/nautobot/cookiecutter-nautobot-app"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
[tool.poetry.dependencies]
cookiecutter = "^2.3.0"
python = "^3.8"
pyyaml = "*"
[tool.poetry.group.dev.dependencies]
bandit = "*"
coverage = "*"
invoke = "*"
isort = "*"
pylint = "*"
pytest = "*"
pytest-cookies = "*"
ruff = "0.5.5"
yamllint = "*"
Markdown = "*"
# Render custom markdown for version added/changed/remove notes
markdown-version-annotations = "1.0.1"
# Rendering docs to HTML
mkdocs = "1.5.2"
# Material for MkDocs theme
mkdocs-material = "9.1.15"
# Automatic documentation from sources, for MkDocs
mkdocstrings = "0.22.0"
mkdocstrings-python = "1.5.2"
[tool.pylint.master]
ignore = ".venv"
[tool.pylint.basic]
# No docstrings required for private methods (Pylint default), or for test_ functions, or for inner Meta classes.
no-docstring-rgx = "^(_|test_|Meta$)"
[tool.pylint.messages_control]
disable = """,
line-too-long
"""
[tool.pylint.miscellaneous]
# Don't flag TODO as a failure, let us commit with things that still need to be done in the code
notes = """,
FIXME,
XXX,
"""
[tool.ruff]
line-length = 120
target-version = "py38"
exclude = [
"nautobot-app*",
]
[tool.ruff.lint]
select = [
"D", # pydocstyle
"F", "E", "W", # flake8
"PL", # pylint
"S", # bandit
"I", # isort
]
ignore = [
# warning: `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible.
"D203", # 1 blank line required before class docstring
# D212 is enabled by default in google convention, and complains if we have a docstring like:
# """
# My docstring is on the line after the opening quotes instead of on the same line as them.
# """
# We've discussed and concluded that we consider this to be a valid style choice.
"D212", # Multi-line docstring summary should start at the first line
"D213", # Multi-line docstring summary should start at the second line
# Produces a lot of issues in the current codebase.
"D401", # First line of docstring should be in imperative mood
"D407", # Missing dashed underline after section
"D416", # Section name ends in colon
"E501", # Line too long
]
[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.pytest.ini_options]
testpaths = [
"nautobot-app/tests",
"nautobot-app-chatops/tests",
"nautobot-app-ssot/tests",
]
addopts = "--color=yes"