Metadata-Version: 2.1
Name: pyloxone-api
Version: 0.2.3
Summary: A package for interacting at a low(ish) level with a Loxone miniserver via the Loxone websocket API
Home-page: https://github.com/JoDehli/pyloxone-api
License: Apache-2.0
Author: Joachim Dehli
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Home Automation
Requires-Dist: httpx (>=0.19.0,<0.20.0)
Requires-Dist: pycryptodome (>=3.10.1,<4.0.0)
Requires-Dist: websockets (>=9.0.1,<10.0.0)
Project-URL: Bug Tracker, https://github.com/JoDehli/pyloxone-api/issues
Project-URL: Repository, https://github.com/JoDehli/pyloxone-api
Description-Content-Type: text/markdown

Pyloxone-api
============

A Python API for communicating with a [Loxone](http://www.loxone.com)
miniserver.
 
 

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyloxone-api?style=flat-square)
![PyPI - License](https://img.shields.io/pypi/l/pyloxone-api?style=flat-square)
[![PyPI](https://img.shields.io/pypi/v/pyloxone-api?style=flat-square)](https://pypi.python.org/pypi/pyloxone-api/)
 
 
 

Development
===========

We use [Poetry](https://python-poetry) for package and environment management,
[Black](https://pypi.org/project/black/) and [isort](https://pypi.org/project/isort/)
for code formatting, and [Pytest](https://pytest.org) for testing.

* Install [Poetry](https://python-poetry)

* Clone the project from Github, and use `Poetry` to install a virtual
  environment and all dependencies:
    ```shell
    > git clone https://github.com/jodehli/pyloxone-api
    > cd pyloxone-api
    > poetry install
    ```

* Activate the virtual environment and create a shell:
    ```shell
    > poetry shell
    ```

* To test, make sure the virtual environment is activiated, and run `pytest`:
    ```shell
    > 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:

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

