# 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/2b/80/25254a9689da4bea5d045e0c25d340da1ceb1c963714d050d1665da75b61/pydrawise-2024.6.5.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.6.5",
"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": "41ca90983faed437863ebc2163a9be58df71d0ad6b333294c87df4001d45f653",
"md5": "977cd0712c288e2b8df303d37052da6a",
"sha256": "d72dd85a4185c231643df604fd8e6ee159605d201356180be45899284c50b05d"
},
"downloads": -1,
"filename": "pydrawise-2024.6.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "977cd0712c288e2b8df303d37052da6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 34260,
"upload_time": "2024-06-22T18:18:33",
"upload_time_iso_8601": "2024-06-22T18:18:33.152549Z",
"url": "https://files.pythonhosted.org/packages/41/ca/90983faed437863ebc2163a9be58df71d0ad6b333294c87df4001d45f653/pydrawise-2024.6.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b8025254a9689da4bea5d045e0c25d340da1ceb1c963714d050d1665da75b61",
"md5": "14aa281e208d5f14e451099c322a164d",
"sha256": "7c5001bb7cb0d2f7d89147d3e30c8a6b7f218fbf68f44c7572effe5e7638d858"
},
"downloads": -1,
"filename": "pydrawise-2024.6.5.tar.gz",
"has_sig": false,
"md5_digest": "14aa281e208d5f14e451099c322a164d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 45267,
"upload_time": "2024-06-22T18:18:34",
"upload_time_iso_8601": "2024-06-22T18:18:34.667974Z",
"url": "https://files.pythonhosted.org/packages/2b/80/25254a9689da4bea5d045e0c25d340da1ceb1c963714d050d1665da75b61/pydrawise-2024.6.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-22 18:18:34",
"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.9.5"
]
]
},
{
"name": "apischema",
"specs": [
[
"==",
"0.18.1"
]
]
},
{
"name": "gql",
"specs": [
[
"==",
"3.5.0"
]
]
},
{
"name": "graphql-core",
"specs": [
[
"==",
"3.2.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
}
],
"lcname": "pydrawise"
}