Skip to content
 
 

Repository files navigation

🚨 simplisafe-python: A Python3, async interface to the SimpliSafe™ API

CI PyPi Version License Code Coverage Maintainability Say Thanks

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.

2021-09-28: Important Update

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.

Documentation

You can find complete documentation here: https://simplisafe-python.readthedocs.io

Contributing

  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.
  7. Write tests that cover your new functionality.
  8. Run tests and ensure 100% code coverage: script/test
  9. Update README.md with any new documentation.
  10. Add yourself to AUTHORS.md.
  11. Submit a pull request!

About

🚨 A Python3, asyncio-based interface to the SimpliSafe™ API

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages