Pyloxone-api

A Python API for communicating with a Loxone miniserver.    

Development

We use Poetry for package and environment management, Black and isort for code formatting, and Pytest for testing.

• Install Poetry

• Clone the project from Github, and use Poetry to install a virtual environment and all dependencies:

  > git clone https://github.com/jodehli/pyloxone-api
  > cd pyloxone-api
  > poetry install
  

• Activate the virtual environment and create a shell:

  > poetry shell
  

• To test, make sure the virtual environment is activiated, and run pytest:

  > pytest
  

• There are some tests which require a live miniserver on the network. They are slower, and are not run by default. Be careful with these tests—they might make your miniserver behave oddly. To run them, you must specify appropriate credentials, eg:

  > pytest --host=192.168.1.100 --port=80  --username=admin --password=admin