Enasis Network Homie Automate
Project description
Enasis Network Homie Automate
:children_crossing: This project has not released its first major version.
Define desired scenes for groups using flexible conditional plugins.
Configuration example
Some basic configuration examples. See next section for more documentation.
- Homie Desires
- Homie Actions
- Homie Groups
- Homie Scenes
- Philips Hue Bridges
- Philips Hue Devices
- Ubiquiti Routers
- Ubiquiti Clients
Documentation
Documentation is on Read the Docs.
Should you venture into the sections below you will be able to use the
sphinx
recipe to build documention in the docs/html
directory.
Additional scripts
- desired.py is useful for setting desired scenes.
- actions.py is useful for acting on stream events.
- dumper.py is useful for dumping configuration.
- scener.py is useful for setting scene on groups.
Useful and related links
Installing the package
Installing stable from the PyPi repository
pip install enhomie
Installing latest from GitHub repository
pip install git+https://github.com/enasisnetwork/enhomie
Quick start for local development
Start by cloning the repository to your local machine.
git clone https://github.com/enasisnetwork/enhomie.git
Set up the Python virtual environments expected by the Makefile.
make -s venv-create
Execute the linters and tests
The comprehensive approach is to use the check
recipe. This will stop on
any failure that is encountered.
make -s check
However you can run the linters in a non-blocking mode.
make -s linters-pass
And finally run the various tests to validate the code and produce coverage
information found in the htmlcov
folder in the root of the project.
make -s pytest
Version management
:warning: Ensure that no changes are pending.
-
Rebuild the environment.
make -s check-revenv
-
Update the version.txt file.
-
Push to the
main
branch. -
Create repository release.
-
Build the Python package.
make -s pypackage
-
Upload Python package to PyPi test.
make -s pypi-upload-test
-
Upload Python package to PyPi prod.
make -s pypi-upload-prod
-
Update Read the Docs documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.