# Pydrawise
[![Build and Test](https://github.com/dknowles2/pydrawise/workflows/Build%20and%20Test/badge.svg)](https://github.com/dknowles2/pydrawise/actions/workflows/build-and-test.yml)
[![pypi version](https://img.shields.io/pypi/v/pydrawise.svg)](https://pypi.python.org/pypi/pydrawise)
[![docs](https://readthedocs.org/projects/pydrawise/badge/?version=latest)](https://pydrawise.readthedocs.io/en/latest/?badge=latest)
Pydrawise is an asynchronous Python 3 library for interacting with Hydrawise sprinkler controllers.
*Note that this project has no official relationship with Hydrawise or Hunter. Use at your own risk.*
## Usage
```python
import asyncio
from pydrawise import Auth, Hydrawise
async def main():
# Create a Hydrawise object and authenticate with your credentials.
h = Hydrawise(Auth("username", "password"))
# List the controllers attached to your account.
controllers = await h.get_controllers()
# List the zones controlled by the first controller.
zones = await h.get_zones(controllers[0])
# Start the first zone.
await h.start_zone(zones[0])
if __name__ == "__main__":
asyncio.run(main())
```
## Installation
### Pip
To install pydrawse, run this command in your terminal:
```sh
$ pip install pydrawise
```
### Source code
Pydrawise is actively developed on Github, where the code is [always available](https://github.com/dknowles2/pydrawise).
You can either clone the public repository:
```sh
$ git clone https://github.com/dknowles2/pydrawise
```
Or download the latest [tarball](https://github.com/dknowles2/pydrawise/tarball/main):
```sh
$ curl -OL https://github.com/dknowles2/pydrawise/tarball/main
```
Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:
```sh
$ cd pydrawise
$ python -m pip install .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pydrawise",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "hydrawise, api, iot",
"author": null,
"author_email": "David Knowles <dknowles2@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fc/b7/8714ba2b00355a38513b49969ec23d02349d1bd99674533e35681d08c869/pydrawise-2024.9.0.tar.gz",
"platform": "any",
"description": "# Pydrawise\n\n[![Build and Test](https://github.com/dknowles2/pydrawise/workflows/Build%20and%20Test/badge.svg)](https://github.com/dknowles2/pydrawise/actions/workflows/build-and-test.yml)\n[![pypi version](https://img.shields.io/pypi/v/pydrawise.svg)](https://pypi.python.org/pypi/pydrawise)\n[![docs](https://readthedocs.org/projects/pydrawise/badge/?version=latest)](https://pydrawise.readthedocs.io/en/latest/?badge=latest)\n\nPydrawise is an asynchronous Python 3 library for interacting with Hydrawise sprinkler controllers.\n\n*Note that this project has no official relationship with Hydrawise or Hunter. Use at your own risk.*\n\n## Usage\n\n```python\nimport asyncio\n\nfrom pydrawise import Auth, Hydrawise\n\n\nasync def main():\n # Create a Hydrawise object and authenticate with your credentials.\n h = Hydrawise(Auth(\"username\", \"password\"))\n\n # List the controllers attached to your account.\n controllers = await h.get_controllers()\n\n # List the zones controlled by the first controller.\n zones = await h.get_zones(controllers[0])\n\n # Start the first zone.\n await h.start_zone(zones[0])\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n## Installation\n\n### Pip\n\nTo install pydrawse, run this command in your terminal:\n\n```sh\n$ pip install pydrawise\n```\n\n### Source code\n\nPydrawise is actively developed on Github, where the code is [always available](https://github.com/dknowles2/pydrawise).\n\nYou can either clone the public repository:\n\n```sh\n$ git clone https://github.com/dknowles2/pydrawise\n```\n\nOr download the latest [tarball](https://github.com/dknowles2/pydrawise/tarball/main):\n\n```sh\n$ curl -OL https://github.com/dknowles2/pydrawise/tarball/main\n```\n\nOnce you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:\n\n```sh\n$ cd pydrawise\n$ python -m pip install .\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python API for interacting with Hydrawise sprinkler controllers.",
"version": "2024.9.0",
"project_urls": {
"Bug Reports": "https://github.com/dknowles2/pydrawise/issues",
"Homepage": "https://github.com/dknowles2/pydrawise",
"Source Code": "https://github.com/dknowles2/pydrawise"
},
"split_keywords": [
"hydrawise",
" api",
" iot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39b6fb86cad6a144297e05b7149773c3101bcc10f795de742d497fad2ec9e812",
"md5": "e841201caef85d3c8c1002d8005987aa",
"sha256": "167e7bb8b063b9d4863f21a97d0575a6e6daa8caa3b664e7d4e48f9c7346af8d"
},
"downloads": -1,
"filename": "pydrawise-2024.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e841201caef85d3c8c1002d8005987aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 34256,
"upload_time": "2024-09-21T23:50:08",
"upload_time_iso_8601": "2024-09-21T23:50:08.669592Z",
"url": "https://files.pythonhosted.org/packages/39/b6/fb86cad6a144297e05b7149773c3101bcc10f795de742d497fad2ec9e812/pydrawise-2024.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fcb78714ba2b00355a38513b49969ec23d02349d1bd99674533e35681d08c869",
"md5": "9721ddfea9a2856d81b50d346f636a80",
"sha256": "afbe90858c6bba5e36ae9be285ffa01e0976b6fd31421907ee46e75601d6c6ed"
},
"downloads": -1,
"filename": "pydrawise-2024.9.0.tar.gz",
"has_sig": false,
"md5_digest": "9721ddfea9a2856d81b50d346f636a80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 45013,
"upload_time": "2024-09-21T23:50:10",
"upload_time_iso_8601": "2024-09-21T23:50:10.366934Z",
"url": "https://files.pythonhosted.org/packages/fc/b7/8714ba2b00355a38513b49969ec23d02349d1bd99674533e35681d08c869/pydrawise-2024.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 23:50:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dknowles2",
"github_project": "pydrawise",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.10.5"
]
]
},
{
"name": "apischema",
"specs": [
[
"==",
"0.18.1"
]
]
},
{
"name": "gql",
"specs": [
[
"==",
"3.5.0"
]
]
},
{
"name": "graphql-core",
"specs": [
[
"==",
"3.2.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
}
],
"lcname": "pydrawise"
}