aioguardian
is a Python3, asyncio
-focused library for interacting with
the Guardian line of water valves and sensors from Elexa.
pip install aioguardian
aioguardian
is currently supported on:
- Python 3.6
- Python 3.7
- Python 3.8
Complete documentation can be found here: http://aioguardian.readthedocs.io
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- (optional, but highly recommended) Create a virtual environment:
python3 -m venv .venv
- (optional, but highly recommended) Enter the virtual environment:
source ./.venv/bin/activate
- Install the dev environment:
script/setup
- Code your new feature or bug fix.
- Write tests that cover your new functionality.
- Run tests and ensure 100% code coverage:
script/test
- Update
README.md
with any new documentation. - Add yourself to
AUTHORS.md
. - Submit a pull request!