Metadata-Version: 2.4
Name: wirely
Version: 0.1.1
Summary: Node-based language and runtime for low-level home automation
Author: Steffen Kieß
License: MIT
Project-URL: Repository, https://github.com/steffen-kiess/wirely
Project-URL: Issues, https://github.com/steffen-kiess/wirely/issues
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lark>=1.1.5
Requires-Dist: sdnotify>=0.3.0
Provides-Extra: knx
Requires-Dist: xknx<4,>=3.0; extra == "knx"
Provides-Extra: mqtt
Requires-Dist: aiomqtt<3,>=2.3; extra == "mqtt"
Provides-Extra: two-n
Requires-Dist: aiohttp<4,>=3.12; extra == "two-n"
Requires-Dist: cryptography>=38.0.0; extra == "two-n"
Provides-Extra: graphviz
Requires-Dist: graphviz>=0.20.1; extra == "graphviz"
Provides-Extra: gpio
Requires-Dist: gpiod<3,>=2.1; extra == "gpio"
Provides-Extra: all
Requires-Dist: wirely[gpio,graphviz,knx,mqtt,two-n]; extra == "all"
Provides-Extra: test
Requires-Dist: pyOpenSSL>=23.0.0; extra == "test"
Provides-Extra: pex
Requires-Dist: pex; extra == "pex"
Provides-Extra: dev
Requires-Dist: wirely[pex,test]; extra == "dev"
Requires-Dist: uv; extra == "dev"
Dynamic: license-file

Wirely
======

Wirely is a node-based language and runtime for low-level home automation.
It connects signals from KNX group addresses, MQTT topics, and other device
interfaces through nodes that process values and apply logic. For example,
it can listen for boolean values on two KNX group addresses and publish
`first_value AND NOT second_value` to a third. Wirely works directly with
these signals; it does not model higher-level concepts such as rooms,
as Home Assistant does.

See the [language documentation](doc/language.md) for how to write Wirely
programs and the [changelog](CHANGELOG.md) for release notes and migration
steps.

Installation
------------

Wirely requires Python 3.11 or newer. Install the core package with:

```
python3 -m pip install wirely
```

The core install includes the compiler and command-line interface. The
installed `wirely` command and `python3 -m wirely` provide the same
subcommands. For example:

```
wirely compile program.wrl
python3 -m wirely compile program.wrl
```

Use `wirely compile --dump-program program.wrl` to print the compiled
runtime program, including its variables, configuration, and procedures.

Install optional integrations as needed:

```
python3 -m pip install 'wirely[knx]'           # KNX
python3 -m pip install 'wirely[mqtt]'          # MQTT
python3 -m pip install 'wirely[two-n]'         # 2N devices
python3 -m pip install 'wirely[graphviz]'      # show-graph
python3 -m pip install 'wirely[gpio]'          # GPIO
python3 -m pip install 'wirely[all]'           # all optional integrations
```

The `test` extra adds dependencies used only by the test suite. Install
`wirely[all,test]` to include both integrations and test dependencies.

Development checkout
--------------------

Create a virtual environment with all dependencies, then use the
checkout launchers:

```
tools/setup-venv
tools/wirely compile test/wrl/simple.wrl
tools/run-tests
```

The launchers use `venv/bin/python` when available. Otherwise, they warn and
use the current Python interpreter. `tools/wirely` accepts the same arguments
as `wirely` and runs the source in this checkout from any working directory.
The test suite also requires `knxd` and `mosquitto`.

Test dependency and Python versions in temporary environments:

```
tools/run-tests-dependencies --versions min --python min
tools/run-tests-dependencies --versions max --python max
tools/run-tests-dependencies --versions all-min --python 3.11
```

`--versions` defaults to `min`: minimum direct dependencies, with latest
compatible transitive dependencies. `all-min` also minimizes transitive
dependencies; `max` selects the newest compatible dependency set.

`--python` accepts a uv version request or an executable name/path and
defaults to the interpreter running the script. `min` selects the latest
compatible patch of the oldest supported CPython minor; `max` selects the
newest compatible stable CPython available through the installed uv.
uv can download missing interpreters. `tools/run-tests --python PATH` runs
tests using a specified Python executable.
