Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.83 KB

README.md

File metadata and controls

71 lines (56 loc) · 2.83 KB

🚰 aioguardian: A Python3 library for Elexa Guardian devices

CI PyPI Version License Code Coverage Maintainability

Buy Me A Coffee

aioguardian is a Python3, asyncio-focused library for interacting with the Guardian line of water valves and sensors from Elexa.

Installation

pip install aioguardian

Python Versions

aioguardian is currently supported on:

  • Python 3.10
  • Python 3.11
  • Python 3.12

Documentation

Complete documentation can be found here.

Contributing

Thanks to all of our contributors so far!

  1. Check for open features/bugs or initiate a discussion on one.
  2. Fork the repository.
  3. (optional, but highly recommended) Create a virtual environment: python3 -m venv .venv
  4. (optional, but highly recommended) Enter the virtual environment: source ./.venv/bin/activate
  5. Install the dev environment: script/setup
  6. Code your new feature or bug fix on a new branch.
  7. Write tests that cover your new functionality.
  8. Run tests and ensure 100% code coverage: poetry run pytest --cov aioguardian tests
  9. Update README.md with any new documentation.
  10. Submit a pull request!