search

bachya / eufy-security-ws-python

A Python wrapper around eufy-security-ws
MIT License
16 stars 3 forks source link

readme

🚨 eufy-security-ws-python: A Python wrapper around eufy-security-ws

NOTE: THIS PROJECT IS NO LONGER ACTIVE. AS AN ALTERNATIVE, PLEASE CHECK OUT https://github.com/fuatakgun/eufy_security.

CI PyPi Version License Code Coverage Maintainability Say Thanks

eufy-security-ws-python is a simple Python wrapper around https://github.com/bropat/eufy-security-ws.

Installation

pip install eufy-security-ws-python

Python Versions

eufy-security-ws-python is currently supported on:

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!