pyproject.toml

[project]
name = "appdaemon"
description="Apps for the Home Assistant home automation package."
readme = "README.md"
authors = [
    {name = "Andrew I Cockburn", email = "appdaemon@acockburn.com"},
]
dynamic = ["version"] # The version is computed dynamically. See `tool.setuptools.dynamic` section below.
license-files = [ "LICENSE.md" ]
requires-python = ">=3.10,<3.13"
keywords=[ "appdaemon", "home", "automation" ]
dependencies = [
    'importlib-metadata; python_version<"3.8"',
    'aiohttp >= 3.9.0,< 3.12.0',
    'aiohttp_jinja2 >= 1.5.1,< 1.7.0',
    'astral ~= 3.2',
    'bcrypt >= 4.0.1,< 4.3.0',
    'deepdiff == 8.2.0',
    'feedparser ~= 6.0.10',
    'iso8601 >= 1.1,< 2.2',
    'paho-mqtt >= 1.6.1,< 2.2.0',
    "pid~=3.0.4",
    'python-dateutil >= 2.8.2,< 2.10.0',
    'python-socketio >= 5.5,< 5.12',
    'pytz >= 2022.7.1,< 2025.2.0',
    'pyyaml ~= 6.0.1',
    'requests >= 2.28.2,< 2.33.0',
    'sockjs >= 0.11,< 0.14',
    'uvloop==0.21.0; sys_platform != "win32"',
    'tomli==2.2.1',
    'tomli_w >= 1.0,< 1.3',
    'pydantic ~= 2.10.6',
]

classifiers= [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Home Automation",    
    "Typing :: Typed",
]

[project.urls]
documentation = "https://appdaemon.readthedocs.io"
repository = "https://github.com/AppDaemon"
changelog = "https://github.com/AppDaemon/appdaemon/blob/master/docs/HISTORY.rst"


# Declare development dependencies as optional
[project.optional-dependencies]
dev = [
    "build>=1.2.1",
    "gitpython>=3.1.43",
    "ipykernel>=6.29.5",
    "notebook>=7.3.2",
    "pre-commit>=3.8.0",
    "pytest>=8.3.2",
    "pytest-asyncio>=1.0.0",
    "rich>=13.8.0",
    "ruff>=0.6.3",
]

# Dependencies required to build the documentation using sphinx
doc = [
    "sphinx-autobuild>=2021.3.14",
    "sphinx-rtd-theme>=3.0.2",
    "sphinx-copybutton>=0.5.2",
    "sphinx-tabs>=3.4.7",
    "pygments>=2.14",
    "myst-parser>=4.0.0",
]

# Define the main CLI script
[project.scripts]
appdaemon = "appdaemon.__main__:main"

# Use setuptools as the build system
[build-system]
requires = ["setuptools >= 61.0.0"]
build-backend = "setuptools.build_meta"

# Tell setuptools how to find the package source files
# https://setuptools.pypa.io/en/latest/userguide/package_discovery.html
[tool.setuptools.packages.find]
exclude = ["contrib", "docs", "docs.*", "tests*"]

# Dynamically read version from version.py module
# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata
[tool.setuptools.dynamic]
version = {attr = "appdaemon.version.__version__"}

# https://docs.pytest.org/en/stable/explanation/goodpractices.html
[tool.pytest.ini_options]
asyncio_mode = "strict"
asyncio_default_test_loop_scope = "session"
asyncio_default_fixture_loop_scope = "session"
addopts = ["--import-mode=importlib"]
markers = [
    "ci: mark test to run in CI environment",
    "functional: mark test as functional test",
    "unit: mark test as unit test",
]

# black configuration
[tool.black]
line-length = 120

# Ruff

[tool.ruff]

src = ["appdaemon", "tests"]

# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".devenv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]

line-length = 200
indent-width = 4

# Assume Python 3.10.
target-version = "py310"

# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
lint.select = ["E", "F"]
lint.ignore = []

# Allow autofix for all enabled rules (when `--fix`) is provided.
lint.fixable = ["E", "F", "UP"]
# lint.fixable = ["ALL"]
lint.unfixable = []

# Allow unused variables when underscore-prefixed.
lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

lint.per-file-ignores = {}

[tool.ruff.lint.mccabe]
# Unlike Flake8, default to a complexity level of 10.
max-complexity = 10

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
docstring-code-format = false

[tool.uv]
dev-dependencies = [
    "build>=1.2.1",
    "gitpython>=3.1.43",
    "ipykernel>=6.29.5",
    "notebook>=7.3.2",
    "pre-commit>=3.8.0",
    "pytest>=8.3.2",
    "pytest-asyncio>=1.0.0",
    "rich>=13.8.0",
    "ruff>=0.6.3",
]

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*,*.svg,*.css,*.min.*,*.map,assets,.venv*,.docs_build,*.js'
check-hidden = true
# ignore-regex = ''
ignore-words-list = 'hass,noone,dependee,dependees,whet,controle'