simplisafe-python (hereafter referred to as simplipy) is a Python3,
asyncio-driven interface to the unofficial SimpliSafeâ„¢ API. With it, users can
get data on their system (including available sensors), set the system state,
and more.
In Q3 2021, users noticed that the traditional way of authenticating this library was scheduled to be deprecated. The latest version of the library is able to accommodate this, but it is substantially different from the previous method. A thorough reading of the documentation is highly recommended.
You can find complete documentation here: https://simplisafe-python.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.mdwith any new documentation. - Add yourself to
AUTHORS.md. - Submit a pull request!