Skip to content

Commit

Permalink
Merge pull request #4 from NitorCreations/uv-instructions
Browse files Browse the repository at this point in the history
Add uv usage instructions and update dependencies
  • Loading branch information
Jalle19 authored Sep 16, 2024
2 parents b4f27c8 + a8cfddd commit 5a631e8
Show file tree
Hide file tree
Showing 3 changed files with 114 additions and 66 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,36 @@ Home Assistant integration for Extron switchers and audio processors.

## Requirements

Devices must have Telnet access enabled
Devices must have Telnet access enabled.

## Features

Obviously not every single feature can be controlled, only the basics:
Not every single feature can be controlled, only the basics:

* Media player support
* Source selection
* Volume control (SSP 200 only)
* Reboot button
* Temperature sensor (SSP 200 only)

The communication is done using Python's `asyncio` and requires no external libraries
The communication is done using Python's `asyncio` and requires no external libraries.

## Development

For local development,
use [uv](https://github.com/astral-sh/uv) to handle the Python dependencies and virtual env.
Install uv with their standalone installer script or with package managers like homebrew.

Use `uv sync` to automatically create a virtual env and install the dependencies.

Update all dependencies with `uv lock --upgrade`.

### Tests

```bash
# Using uv managed virtual env
uv run python -m unittest discover -s tests/ -v
# Manually activated virtual env with necessary dependencies
python3 -m unittest discover -s tests/ -v
```

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description = "Home Assistant integration for Extron switchers and audio process
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.12"
dependencies = ["homeassistant"]
dependencies = ["homeassistant", "bidict"]

[tool.black]
# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
Expand Down
Loading

0 comments on commit 5a631e8

Please sign in to comment.