Merge pull request #162 from loopj/refactor

[WIP] Refactor to have "objects" inherit from "object_interfaces"

.github/workflows/check.yml

@@ -0,0 +1,44 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --all-extras --dev
+
+    - name: Add venv to PATH
+      run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
+
+    - name: Run ruff linter
+      uses: astral-sh/ruff-action@v2
+      with:
+        args: check
+
+    - name: Run ruff formatter
+      uses: astral-sh/ruff-action@v2
+      with:
+        args: format --check
+
+    - name: Run pyright
+      uses: jakebailey/pyright-action@v2

.gitignore

@@ -8,3 +8,4 @@ __pycache__/
 *.so
 *~
 .idea
+uv.lock

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff"
+    ]
+}

CONTRIBUTING.md

@@ -18,21 +18,30 @@ First off, thanks for taking the time to contribute!
 
 ## 🔨 Set up Development Environment
 
-### Using `hatch`
+### Using `uv`
 
-aiovantage uses [Hatch](https://hatch.pypa.io/) to run scripts, manages virtual environments, create reproducible builds, and publish packages. Check out the [Hatch installation guide](https://hatch.pypa.io/latest/install/) to get started.
+aiovantage uses [uv](https://docs.astral.sh/uv/) to run scripts, manages virtual environments, create reproducible builds, and publish packages. Check out the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) to get started.
 
-If you'd like to run a command in a virtual environment with development dependencies available, prefix it with `hatch -e dev run`. For example,
+To set up your development environment, run the following commands:
 
 ```bash
-hatch -e dev run python examples/dump_system.py hostname
+uv venv
+uv pip install -e ".[dev]"
+```
+
+If you'd like to run a command in a virtual environment with development dependencies available, prefix it with `uv run`. For example,
+
+```bash
+uv run python examples/dump_system.py hostname
 ```
 
 ### Manually
 
 If you'd prefer to manage your own python environment, you can install the development dependencies manually.
 
 ```bash
+python -m venv .venv
+source .venv/bin/activate
 pip install -e ".[dev]"
 ```
 
@@ -42,12 +51,12 @@ pip install -e ".[dev]"
 
 To add a new object type to an existing controller, follow these steps:
 
-- Create a new [xsdata-style `@dataclass`](https://xsdata.readthedocs.io/en/latest/models.html) model in `src/aiovantage/config_client/models/`
+- Create a new [xsdata-style `@dataclass`](https://xsdata.readthedocs.io/en/latest/models.html) model in `src/aiovantage/objects/`
 - The new class should inherit from the appropriate subclass expected by the controller
 - Your class name should match the Vantage object name if possible, otherwise use [class metadata](https://xsdata.readthedocs.io/en/latest/models.html#class-metadata) to specify the name
-- Export the class in `src/aiovantage/config_client/models/__init__.py` so it can be automatically parsed
-- Add the object name to the `vantage_types` tuple in the appropriate controller in `src/aiovantage/config_client/controllers/`, so we know to fetch it when populating the controller
-- Test that the object appears in the controller, by running the `dump_system.py` example script
+- Export the class in `src/aiovantage/objects/__init__.py` so it can be automatically parsed
+- Add the object type to the `vantage_types` tuple in the appropriate controller in `src/aiovantage/controllers/`, so we know to fetch it when populating the controller
+- Test that the object appears in the controller as expected
 
 ### Adding support for a new class of device
 
@@ -61,57 +70,48 @@ Good pull requests remain focused in scope and avoid containing unrelated commit
 
 ## 🎨 Style guidelines
 
-This project uses [pre-commit](https://pre-commit.com/) to run code linting and formatting checks before commits are made.
-
-To install `pre-commit` and its associated hooks, run the following:
-
-```bash
-pip install pre-commit
-pre-commit install
-```
+Before submitting a pull request, make sure your code follows the style guidelines.
 
-To run our linters on the full code base, run the following command:
+Use pyright for type checking:
 
 ```bash
-pre-commit run --all-files
+uv run pyright
 ```
 
-## 📦️ Build a package
-
-To build the package, first bump the version
+Use Ruff for linting:
 
 ```bash
-hatch version <major|minor|patch>
+uv run ruff check
 ```
 
-Then build the package
+Use Ruff for formatting:
 
 ```bash
-hatch build -c
+uv run ruff format
 ```
 
-## 🚀 Publish a release
+If you are using vscode, you'll be prompted to install the recommended extensions when you open the workspace.
 
-Follow these steps to publish the release on PyPi.
+## 📦️ Build a package
 
-Commit `src/aiovantage/__about__.py` to source control
+To build the package, first update the version number:
 
 ```bash
-git add src/aiovantage/__about__.py
-git commit -m "Preparing release `hatch version`"
+bumpver update --patch # or --major --minor
 ```
 
-Tag the release
+Then build the package:
 
 ```bash
-git tag `hatch version`
-git push && git push --tags
+uv build
 ```
 
-Publish the release to PyPi
+## 🚀 Publish a release
+
+To publish the package to PyPi:
 
 ```bash
-hatch publish
+uv publish
 ```
 
-Don't forget to [create a release on GitHub](https://github.com/loopj/aiovantage/releases/new).
+Don't forget to [create a release on GitHub](https://github.com/loopj/aiovantage/releases/new)!

README.md

@@ -177,7 +177,8 @@ For example, to turn on a load:
 
 ```python
 async with Vantage("hostname", "username", "password") as vantage:
-    await vantage.loads.turn_on(118)
+    load = await vantage.loads.aget(name="Study Lights")
+    load.turn_on()
 ```
 
 ### Subscribing to state changes

examples/anemo_sensors/monitor_anemo_sensors.py

@@ -7,7 +7,7 @@
 from typing import Any
 
 from aiovantage import Vantage, VantageEvent
-from aiovantage.models import AnemoSensor
+from aiovantage.objects import AnemoSensor
 
 # Grab connection info from command line arguments
 parser = argparse.ArgumentParser(description="aiovantage example")

examples/blinds/monitor_blinds.py

@@ -7,7 +7,7 @@
 from typing import Any
 
 from aiovantage import Vantage, VantageEvent
-from aiovantage.models import SystemObject
+from aiovantage.objects import SystemObject
 
 # Grab connection info from command line arguments
 parser = argparse.ArgumentParser(description="aiovantage example")

examples/buttons/monitor_buttons.py

@@ -7,7 +7,7 @@
 from typing import Any
 
 from aiovantage import Vantage, VantageEvent
-from aiovantage.models import Button
+from aiovantage.objects import Button
 
 # Grab connection info from command line arguments
 parser = argparse.ArgumentParser(description="aiovantage example")

examples/dry_contacts/monitor_dry_contacts.py

@@ -7,7 +7,7 @@
 from typing import Any
 
 from aiovantage import Vantage, VantageEvent
-from aiovantage.models import DryContact
+from aiovantage.objects import DryContact
 
 # Grab connection info from command line arguments
 parser = argparse.ArgumentParser(description="aiovantage example")