Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 2.71 KB

README.md

File metadata and controls

53 lines (44 loc) · 2.71 KB
Raw

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

CI PyPI Version License Code Coverage Maintainability

Buy Me A Coffee

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.

Documentation

You can find complete documentation 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 simplipy tests
  9. Update README.md with any new documentation.
  10. Submit a pull request!