pyproject.toml

[project]
name = "shvtree"
version = "0.0.0"
description = "Silicon Heaven Tree"
readme = "README.rst"
license = {file = "LICENSE"}
requires-python = ">=3.11"
dependencies = [
  "pyshv >= 0.4.0",
  "ruamel.yaml",
  "asyncinotify",
]

[project.urls]
"Homepage" = "https://gitlab.com/elektroline-predator/shvtree"
"Bug Tracker" = "https://gitlab.com/elektroline-predator/shvtree/-/issues"

[project.optional-dependencies]
docs = [
  "sphinx",
  "sphinx_rtd_theme",
  "sphinx-multiversion",
]
test = [
  "pytest",
  "pytest-asyncio",
  "pytest-cov",
]
lint = [
  "black",
  "isort",
  "mypy",
  "pydocstyle",
  "pylint",
]

[project.scripts]
shvtree-check = "shvtree.check.__main__:main"
shvtree-size = "shvtree.size.__main__:main"
shvtree-dummy = "shvtree.device.__main__:main"

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
exclude = ["docs", "tests*"]
[tool.setuptools.package-data]
"*" = ["py.typed"]

[tool.pytest.ini_options]
asyncio_mode = "auto"

[tool.coverage.run]
branch = true
omit = ["tests/*"]
[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "if typing.TYPE_CHECKING:"
]

[tool.isort]
profile = 'black'

[tool.pylint.main]
recursive = "y"
ignore = ["tests", "docs"]
fail-under = 9.5
[tool.pylint.format]
disable = [
  # Exception can be safely caught because there is BaseException for unsafe
  # ones (such as SystemExit) and there are reasons to catch all exceptions.
  "W0718",
  # Prevent usage of module name in documentation (seems unreasonable)
  "C0104",
  # We have pydocstyle for the following ones
  "C0103", "C0114", "C0115", "C0116",
]
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html
max-line-length = 88