Cleanup development dependencies. Add initial packaging support

Author: rvanw12

.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig helps maintain consistent coding styles for multiple developers
+# See https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 150
+
+[*.{yaml,yml,json}]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ['3.11', '3.12']
+        python-version: ['3.11', '3.14']
 
     steps:
     - name: Checkout code
@@ -30,20 +30,19 @@ jobs:
       run: |
         python -m pip install --upgrade pip setuptools wheel
         pip install -r requirements.txt
+        pip install -r requirements-dev.txt
 
     - name: Verify package can be installed
       run: |
         pip install -e .
 
     - name: Run unit tests
       run: |
-        python -m pip install --upgrade pip
-        pip install pytest
         pytest -q
 
     - name: Verify CLI is available
       run: |
-        tado-local --help
+        python -m tado_local --help
 
     - name: Check Python syntax
       run: |
@@ -101,7 +100,7 @@ jobs:
     - name: Install linting tools
       run: |
         python -m pip install --upgrade pip
-        pip install ruff flake8
+        pip install -r requirements-dev.txt
 
     - name: Run Ruff
       run: |

.pylintrc

@@ -0,0 +1,17 @@
+[MASTER]
+ignore=env,venv,.env,.venv,__pycache__,.git
+jobs=1
+module-rgx=([A-Za-z][A-Za-z0-9_]*)$
+
+# Relax function/variable regexes slightly to avoid many C0103 invalid-name
+# complaints for project-specific short names or mixed-case usages.
+variable-rgx=[a-z_][a-z0-9_]{0,30}$
+function-rgx=[a-z_][a-z0-9_]{0,30}$
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+[MESSAGES CONTROL]
+; package-rgx not supported by older pylint versions - omitted
+disable=C0114,C0115,C0116,R0913,R0903,C0103,R0914,R0912,R0915,R1702,C0302,R0801,W1203,W0718,W0719,W0212,W0612,E1101,R0911,W1201,W0622,R1723,R1705,R1724,C1802,R0916
+
+[FORMAT]
+max-line-length=150

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to TadoLocal
+
+Thank you for your interest in contributing to TadoLocal! This document provides guidelines for developers.
+
+## Development Setup
+
+### Prerequisites
+- Python 3.11 or later
+- pip and virtualenv (recommended)
+
+### Initial Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/ampscm/TadoLocal.git
+   cd TadoLocal
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install runtime and development dependencies:
+   ```bash
+   pip install -r requirements.txt
+   pip install -r requirements-dev.txt
+   ```
+
+4. Install the package in development mode:
+   ```bash
+   pip install -e .
+   ```
+
+## Running Tests
+
+Run all tests:
+```bash
+pytest
+```
+
+Run tests with verbose output:
+```bash
+pytest -v
+```
+
+Run tests with coverage:
+```bash
+pytest --cov=tado_local --cov-report=html
+```
+
+## Code Quality
+
+The project uses the following tools for code quality:
+
+- **ruff**: Fast Python linter (excludes domoticz/)
+- **flake8**: Additional linting
+- **black**: Code formatting (configured in pyproject.toml)
+- **pytest-asyncio**: Testing async code
+
+### Running Code Quality Checks
+
+```bash
+ruff check .
+flake8 tado_local/
+```
+
+## Project Structure
+
+- `tado_local/` - Main package
+- `domoticz/` - Domoticz plugin (uses namespace packaging)
+- `tests/` - Unit tests
+- `docs/` - Documentation
+- `demos/` - Example scripts
+- `systemd/` - Systemd service files
+
+## Notes for Developers
+
+- **Domoticz Plugin**: The `domoticz/plugin.py` can be used standalone. Tests use a mocked Domoticz module so the plugin can be tested without the Domoticz runtime.
+- **Async Code**: Use `@pytest.mark.asyncio` for async tests (requires pytest-asyncio).
+- **Namespace Packages**: The `domoticz/` folder uses namespace packaging to allow it to be imported separately.
+
+## Open PRs
+
+Please check for existing open PRs before working on new features to avoid conflicts.

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+recursive-include tado_local/static *
+recursive-include domoticz *.py

pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tado-local"
+version = "1.0.0a1"
+description = "Tado-Local - Exposing Tado as local API"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [ { name = "AmpScm" } ]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+]
+
+dependencies = [
+  "aiohomekit>=3.0.0",
+  "fastapi>=0.100.0",
+  "uvicorn[standard]>=0.23.0",
+  "cryptography>=41.0.0",
+  "zeroconf>=0.115.0",
+  "aiohttp>=3.9.0",
+  "dbus-next>=0.2.3",
+]
+
+[project.urls]
+Homepage = "https://github.com/AmpScm/tado-local"
+Repository = "https://github.com/AmpScm/tado-local.git"
+
+[tool.black]
+line-length = 150
+target-version = ['py313']
+skip-string-normalization = true
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tado_local", "domoticz"]
+
+[tool.setuptools.package-data]
+tado_local = ["static/*"]
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore::DeprecationWarning:lark.utils",
+]
+markers = [
+    "asyncio: marks tests as async (deselect with '-m \"not asyncio\"')",
+]
+
+[tool.ruff]
+exclude = ["domoticz/"]
+select = ["E", "W", "F"]

pytest.ini

@@ -1,3 +1,6 @@
 [pytest]
 filterwarnings =
     ignore::DeprecationWarning:lark.utils
+markers =
+    asyncio: marks tests as async (deselect with '-m "not asyncio"')
+

requirements-dev.txt

@@ -0,0 +1,15 @@
+# Development dependencies for TadoLocal
+# Install with: pip install -r requirements-dev.txt
+
+# Testing
+pytest>=8.0.0
+pytest-asyncio>=0.23.0
+pytest-cov>=4.0.0
+
+# Linting and code quality
+ruff>=0.1.0
+flake8>=6.0.0
+
+# Build tools
+build>=0.10.0
+twine>=4.0.0

setup.py

@@ -1,75 +1,23 @@
-"""Setup configuration for Tado Local."""
-#
-# Copyright 2025 The TadoLocal and AmpScm contributors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+"""Setup configuration for Tado Local.
 
-from setuptools import setup, find_packages
+Configuration is primarily defined in pyproject.toml.
+This file provides custom version discovery from __version__.py.
+"""
+
+from setuptools import setup
 from pathlib import Path
 import re
 
-# Read version without importing the package (to avoid dependency issues during setup)
-version_file = Path(__file__).parent / "tado_local" / "__version__.py"
-version_content = version_file.read_text(encoding="utf-8")
-version_match = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', version_content, re.MULTILINE)
-if not version_match:
-    raise RuntimeError("Unable to find version string in __version__.py")
-__version__ = version_match.group(1)
+def get_version():
+    """Read version from tado_local/__version__.py"""
+    version_file = Path(__file__).parent / "tado_local" / "__version__.py"
+    content = version_file.read_text(encoding="utf-8")
+    match = re.search(r'^__version__\s*=\s*[\'"]([^\'"]+)[\'"]', content, re.MULTILINE)
+    if match:
+        return match.group(1)
+    raise RuntimeError("Unable to find __version__ in tado_local/__version__.py")
 
-# Read the README file
-readme_file = Path(__file__).parent / "README.md"
-long_description = readme_file.read_text(encoding="utf-8") if readme_file.exists() else ""
+# Use custom version discovery
+setup(version=get_version())
 
-# Read requirements
-requirements_file = Path(__file__).parent / "requirements.txt"
-requirements = []
-if requirements_file.exists():
-    requirements = [
-        line.strip()
-        for line in requirements_file.read_text(encoding="utf-8").splitlines()
-        if line.strip() and not line.startswith("#")
-    ]
 
-setup(
-    name="tado-local",
-    version=__version__,
-    author="Tado Local Contributors",
-    description="REST API for Tado devices via HomeKit bridge",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/ampscm/TadoLocal",
-    packages=find_packages(),
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: Apache Software License",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Topic :: Home Automation",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-    ],
-    python_requires=">=3.11",
-    install_requires=requirements,
-    extras_require={
-        # Optional Avahi/dbus support for platforms that provide dbus-next
-        'avahi': ['dbus-next>=0.6.0'],
-    },
-    entry_points={
-        "console_scripts": [
-            "tado-local=tado_local.__main__:main",
-        ],
-    },
-    include_package_data=True,
-    zip_safe=False,
-)