Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.33 KB

README.md

File metadata and controls

45 lines (34 loc) · 2.33 KB
Raw

teslajsonpy

Version status License Python version compatibility Version on Github Version on PyPi PyPI - Downloads PyPI - Downloads PyPI - Downloads

Async python module for Tesla API primarily for enabling Home-Assistant.

NOTE: Tesla has no official API; therefore, this library may stop working at any time without warning.

Credits

Originally inspired by this code. Also thanks to Tim Dorr for documenting the API. Additional repo scaffolding from simplisafe-python.

Contributing

  1. Check for open features/bugs or initiate a discussion on one.
  2. Fork the repository.
  3. Install the dev environment: make init.
  4. Enter the virtual environment: poetry shell
  5. Code your new feature or bug fix. Developers Reference
  6. Write a test that covers your new functionality.
  7. Update README.md with any new documentation.
  8. Run tests and ensure 100% code coverage for your contribution: make coverage
  9. Ensure you have no linting errors: make lint
  10. Ensure you have typed your code correctly: make typing
  11. Add yourself to AUTHORS.md.
  12. Submit a pull request!

Documentation

API docs.

License

Apache-2.0. By providing a contribution, you agree the contribution is licensed under Apache-2.0. This code is provided as-is with no warranty. Use at your own risk.