Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GrandMoff100/HomeAssistantAPI
Python Wrapper for Homeassistant's REST API
https://github.com/GrandMoff100/HomeAssistantAPI
aiohttp api async hacktoberfest home-assistant home-automation python requests rest rest-api
Last synced: about 2 months ago
JSON representation
Python Wrapper for Homeassistant's REST API
- Host: GitHub
- URL: https://github.com/GrandMoff100/HomeAssistantAPI
- Owner: GrandMoff100
- License: gpl-3.0
- Created: 2021-03-14T22:42:03.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-18T23:44:39.000Z (3 months ago)
- Last Synced: 2024-11-05T07:21:23.677Z (about 2 months ago)
- Topics: aiohttp, api, async, hacktoberfest, home-assistant, home-automation, python, requests, rest, rest-api
- Language: Python
- Homepage: https://homeassistantapi.readthedocs.io
- Size: 2.07 MB
- Stars: 67
- Watchers: 2
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# HomeassistantAPI
[![Code Coverage](https://img.shields.io/codecov/c/github/GrandMoff100/HomeAssistantAPI/dev?style=for-the-badge&token=SJFC3HX5R1)](https://codecov.io/gh/GrandMoff100/HomeAssistantAPI)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/HomeAssistant-API?style=for-the-badge)](https://pypi.org/project/homeassistant_api)
![GitHub commits since latest release (by date including pre-releases)](https://img.shields.io/github/commits-since/GrandMoff100/HomeassistantAPI/latest/dev?include_prereleases&style=for-the-badge)
[![Read the Docs (version)](https://img.shields.io/readthedocs/homeassistantapi?style=for-the-badge)](https://homeassistantapi.readthedocs.io/en/latest/?badge=latest)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/GrandMoff100/HomeassistantAPI?style=for-the-badge)](https://github.com/GrandMoff100/HomeassistantAPI/releases)## Python wrapper for Homeassistant's [REST API](https://developers.home-assistant.io/docs/api/rest/)
Here is a quick example.
```py
from homeassistant_api import Clientwith Client(
'',
''
) as client:light = client.get_domain("light")
light.turn_on(entity_id="light.living_room_lamp")
```All the methods also support async!
Just prefix the method with `async_`
(i.e. `await light.async_turn_on(...)`).## Documentation
All documentation, API reference, contribution guidelines and pretty much everything else
you'd want to know is on our readthedocs site [here](https://homeassistantapi.readthedocs.io)If there is something missing, open an issue and let us know! Thanks!
Go make some cool stuff! Maybe come back and tell us about it in a
[discussion](https://github.com/GrandMoff100/HomeAssistantAPI/discussions)?
We'd love to hear about how you use our library!!## License
This project is under the GNU GPLv3 license, as defined by the Free Software Foundation.