pyproject.toml

[project]
name = "teslamate-telegram-bot"
description = "A Telegram bot which sends a message if an update for your Tesla is available (use TeslaMate MQTT)."
dynamic = ["version"]
authors = [
  { name = "Jakob Lichterfeld" },
]
license = "AGPL-3.0-or-later"
readme = "README.md"
keywords = ["python", "mqtt", "telegram-bot", "tesla", "mqtt-client", "paho-mqtt", "mqtt-connector", "teslamate-mqtt-topic"]
requires-python = ">=3.13"
dependencies = [
    "paho-mqtt==2.1.0",
    "python-telegram-bot==22.7",
]

[dependency-groups]
# Development only: groups are not part of the distribution and stay out of the
# container image, which installs the project without them. Declared here,
# pinned in uv.lock, which is generated from this file.
lint = ["pylint"]
test = ["pytest", "pytest-cov"]

[project.urls]
repository = "https://github.com/JakobLichterfeld/TeslaMate-Telegram-Bot"
changelog = "https://github.com/JakobLichterfeld/TeslaMate-Telegram-Bot/blob/main/CHANGELOG.md"

[project.scripts]
teslamate-telegram-bot = "teslamate_telegram_bot:main_sync"

[build-system]
requires = ["setuptools>=80", "setuptools-scm>=9"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
package-dir = {"" = "src"}

[tool.pytest.ini_options]
# src layout: make the package importable without installing it first, so the
# suite runs the same way locally and in CI.
pythonpath = ["src"]
testpaths = ["tests"]
# Coverage is reported on every run, locally and in CI, so the number in the
# README badge is never a surprise. The threshold lives in the CI call: a
# filtered local run must not fail just because it covers less.
addopts = ["--cov=teslamate_telegram_bot", "--cov-report=term-missing"]

[tool.coverage.report]
exclude_also = [
    # Runs only when the module is executed as a script.
    'if __name__ == "__main__":',
]

[tool.ruff.lint]
# Selected explicitly: relying on ruff's defaults means an upstream release can
# change which rules apply, as ruff 0.16 did. Line length (E5) stays off, it is
# the formatter's job.
select = [
    "E4",  # pycodestyle: imports
    "E7",  # pycodestyle: statements
    "E9",  # pycodestyle: runtime errors
    "F",   # pyflakes
    "I",   # isort
    "UP",  # pyupgrade, kept in sync with requires-python
    "B",   # flake8-bugbear
    "ARG", # flake8-unused-arguments
    "LOG", # flake8-logging
    "G",   # flake8-logging-format
    "SIM", # flake8-simplify
    "RUF", # ruff-specific rules
    "PL",  # pylint
]

[tool.ruff.lint.per-file-ignores]
# Expected values in a test are literal on purpose; naming them would hide
# what the assertion actually checks.
"tests/**" = ["PLR2004"]