pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "edwh-multipass-plugin"
dynamic = ["version"]
description = 'An `edwh`plugin to work with multipass instances for local development.'
readme = "README.md"
requires-python = ">=3.10"
license = "MIT"
keywords = ['edwh','multipass','plugin','invoke']
authors = [
  { name = "Remco", email = "remco@educationwarehouse.nl" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = [
  "edwh>=0.43",
  "pyyaml",
]

[project.optional-dependencies]
dev = [
    "hatch",
    # "python-semantic-release >= 8.0.0a5",
    "black",
    "su6[all]",
    "types-pyyaml"
]

[project.entry-points."edwh.tasks"]
mp = "edwh_multipass_plugin.tasks"


[project.urls]
Documentation = "https://github.com/educationwarehouse/edwh-multipass-plugin#readme"
Issues = "https://github.com/educationwarehouse/edwh-multipass-plugin/issues"
Source = "https://github.com/educationwarehouse/edwh-multipass-plugin"

[tool.hatch.version]
path = "src/edwh_multipass_plugin/__about__.py"

[tool.hatch.envs.default]
dependencies = [
  "coverage[toml]>=6.5",
  "pytest",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = [
  "- coverage combine",
  "coverage report",
]
cov = [
  "test-cov",
  "cov-report",
]

[[tool.hatch.envs.all.matrix]]
python = ["3.10", "3.11"]

[tool.hatch.envs.lint]
detached = true
dependencies = [
  "black>=23.1.0",
  "mypy>=1.0.0",
  "ruff>=0.0.243",
]
[tool.hatch.envs.lint.scripts]
typing = "mypy --install-types --non-interactive {args:src/edwh_multipass_plugin tests}"
style = [
  "ruff {args:.}",
  "black --check --diff {args:.}",
]
fmt = [
  "black {args:.}",
  "ruff --fix {args:.}",
  "style",
]
all = [
  "style",
  "typing",
]

[tool.black]
target-version = ["py310"]
line-length = 120
skip-string-normalization = true

[tool.ruff]
target-version = "py310"
line-length = 120

[tool.ruff.lint]
select = [
    "F", # pyflake error
    "E", # pycodestyle error
    "W", # pycodestyle warning
    "Q", # quotes
    "A", # builtins
    # "C4", # comprehensions - NO: doesn't allow dict()
    # "RET", # return - NO: annoying
    "SIM", # simplify
    "ARG", # unused arguments
    # "COM", # comma's - NO: annoying
    # "PTH", # use pathlib - NO: annoying
    "RUF", # ruff rules
]
ignore = [
  # Allow non-abstract empty methods in abstract base classes
  "B027",
  # Allow boolean positional values in function calls, like `dict.get(... True)`
  "FBT003",
  # Ignore checks for possible passwords
  "S105", "S106", "S107",
  # Ignore complexity
  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
]
unfixable = [
  # Don't touch unused imports
  "F401",
]

[tool.ruff.lint.isort]
known-first-party = ["edwh_multipass_plugin"]

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.ruff.lint.per-file-ignores]
# Tests can use magic values, assertions, and relative imports
"tests/**/*" = ["PLR2004", "S101", "TID252"]

[tool.coverage.run]
source_pkgs = ["edwh_multipass_plugin", "tests"]
branch = true
parallel = true
omit = [
  "src/edwh_multipass_plugin/__about__.py",
]

[tool.coverage.paths]
edwh_multipass_plugin = ["src/edwh_multipass_plugin", "*/edwh-multipass-plugin/src/edwh_multipass_plugin"]
tests = ["tests", "*/edwh-multipass-plugin/tests"]

[tool.coverage.report]
exclude_lines = [
  "no cov",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
]

[tool.semantic_release]
branch = "main"
version_variable = "src/edwh_multipass_plugin/__about__.py:__version__"
change_log = "CHANGELOG.md"
upload_to_repository = false
upload_to_release = false
build_command = "hatch build"

parser_angular_minor_types = "feat,minor"
parser_angular_patch_types = "fix,perf,refactor,build,chore,patch"


[tool.mypy]
strict = true

[[tool.mypy.overrides]]
module = "fabric"
ignore_missing_imports = true

[[tool.mypy.overrides]]
module = "fabric.main"
ignore_missing_imports = true

[[tool.mypy.overrides]]
module = "fabric.connection"
ignore_missing_imports = true

[tool.su6]
directory = "src"
include = []
exclude = []
stop-after-first-failure = true