| Name | aioguardian JSON |
| Version |
2025.2.0
JSON |
| download |
| home_page | None |
| Summary | A Python3 library for Elexa Guardian water valves and sensors |
| upload_time | 2025-02-04 19:36:48 |
| maintainer | None |
| docs_url | None |
| author | Aaron Bach |
| requires_python | <3.14,>=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🚰 aioguardian: A Python3 library for Elexa Guardian devices
[![CI][ci-badge]][ci]
[![PyPI][pypi-badge]][pypi]
[![Version][version-badge]][version]
[![License][license-badge]][license]
[![Code Coverage][codecov-badge]][codecov]
[![Maintainability][maintainability-badge]][maintainability]
<a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
`aioguardian` is a Python3, `asyncio`-focused library for interacting with
[the Guardian line of water valves and sensors from Elexa][elexa].
- [Installation](#installation)
- [Python Versions](#python-versions)
- [Documentation](#documentation)
- [Contributing](#contributing)
# Installation
```bash
pip install aioguardian
```
# Python Versions
`aioguardian` is currently supported on:
- Python 3.11
- Python 3.12
- Python 3.13
# Documentation
Complete documentation can be found [here][docs].
# Contributing
Thanks to all of [our contributors][contributors] so far!
1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
2. [Fork the repository][fork].
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 on a new branch.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aioguardian tests`
9. Update `README.md` with any new documentation.
10. Submit a pull request!
[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/aioguardian/test.yml
[ci]: https://github.com/bachya/aioguardian/actions
[codecov-badge]: https://codecov.io/gh/bachya/aioguardian/branch/dev/graph/badge.svg
[codecov]: https://codecov.io/gh/bachya/aioguardian
[contributors]: https://github.com/bachya/aioguardian/graphs/contributors
[docs]: http://aioguardian.readthedocs.io
[elexa]: http://getguardian.com
[fork]: https://github.com/bachya/aioguardian/fork
[issues]: https://github.com/bachya/aioguardian/issues
[license-badge]: https://img.shields.io/pypi/l/aioguardian.svg
[license]: https://github.com/bachya/aioguardian/blob/main/LICENSE
[maintainability-badge]: https://api.codeclimate.com/v1/badges/e6521f4a50efd222be18/maintainability
[maintainability]: https://codeclimate.com/github/bachya/aioguardian/maintainability
[new-issue]: https://github.com/bachya/aioguardian/issues/new
[new-issue]: https://github.com/bachya/aioguardian/issues/new
[pypi-badge]: https://img.shields.io/pypi/v/aioguardian.svg
[pypi]: https://pypi.python.org/pypi/aioguardian
[version-badge]: https://img.shields.io/pypi/pyversions/aioguardian.svg
[version]: https://pypi.python.org/pypi/aioguardian
Raw data
{
"_id": null,
"home_page": null,
"name": "aioguardian",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Aaron Bach",
"author_email": "bachya1208@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9c/a9/1e5b3465fc27bce3d4981facbf5759bd0d9ffde5b34fee43fbd577f40b6b/aioguardian-2025.2.0.tar.gz",
"platform": null,
"description": "# \ud83d\udeb0 aioguardian: A Python3 library for Elexa Guardian devices\n\n[![CI][ci-badge]][ci]\n[![PyPI][pypi-badge]][pypi]\n[![Version][version-badge]][version]\n[![License][license-badge]][license]\n[![Code Coverage][codecov-badge]][codecov]\n[![Maintainability][maintainability-badge]][maintainability]\n\n<a href=\"https://www.buymeacoffee.com/bachya1208P\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"></a>\n\n`aioguardian` is a Python3, `asyncio`-focused library for interacting with\n[the Guardian line of water valves and sensors from Elexa][elexa].\n\n- [Installation](#installation)\n- [Python Versions](#python-versions)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n\n# Installation\n\n```bash\npip install aioguardian\n```\n\n# Python Versions\n\n`aioguardian` is currently supported on:\n\n- Python 3.11\n- Python 3.12\n- Python 3.13\n\n# Documentation\n\nComplete documentation can be found [here][docs].\n\n# Contributing\n\nThanks to all of [our contributors][contributors] so far!\n\n1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].\n2. [Fork the repository][fork].\n3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`\n4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`\n5. Install the dev environment: `script/setup`\n6. Code your new feature or bug fix on a new branch.\n7. Write tests that cover your new functionality.\n8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aioguardian tests`\n9. Update `README.md` with any new documentation.\n10. Submit a pull request!\n\n[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/aioguardian/test.yml\n[ci]: https://github.com/bachya/aioguardian/actions\n[codecov-badge]: https://codecov.io/gh/bachya/aioguardian/branch/dev/graph/badge.svg\n[codecov]: https://codecov.io/gh/bachya/aioguardian\n[contributors]: https://github.com/bachya/aioguardian/graphs/contributors\n[docs]: http://aioguardian.readthedocs.io\n[elexa]: http://getguardian.com\n[fork]: https://github.com/bachya/aioguardian/fork\n[issues]: https://github.com/bachya/aioguardian/issues\n[license-badge]: https://img.shields.io/pypi/l/aioguardian.svg\n[license]: https://github.com/bachya/aioguardian/blob/main/LICENSE\n[maintainability-badge]: https://api.codeclimate.com/v1/badges/e6521f4a50efd222be18/maintainability\n[maintainability]: https://codeclimate.com/github/bachya/aioguardian/maintainability\n[new-issue]: https://github.com/bachya/aioguardian/issues/new\n[new-issue]: https://github.com/bachya/aioguardian/issues/new\n[pypi-badge]: https://img.shields.io/pypi/v/aioguardian.svg\n[pypi]: https://pypi.python.org/pypi/aioguardian\n[version-badge]: https://img.shields.io/pypi/pyversions/aioguardian.svg\n[version]: https://pypi.python.org/pypi/aioguardian\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python3 library for Elexa Guardian water valves and sensors",
"version": "2025.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0e3f221ae4e57dea3cfa7cb76843bb61fa9d383916bbb1e2700be8dbb39c7ec9",
"md5": "8bbd972f6a99030f4cf55e52ae9b3c5d",
"sha256": "a21672b18ff32dc3f2eb8108dae9443f946c138cb684f965bd8d11e72212cddd"
},
"downloads": -1,
"filename": "aioguardian-2025.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bbd972f6a99030f4cf55e52ae9b3c5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 14725,
"upload_time": "2025-02-04T19:36:47",
"upload_time_iso_8601": "2025-02-04T19:36:47.132107Z",
"url": "https://files.pythonhosted.org/packages/0e/3f/221ae4e57dea3cfa7cb76843bb61fa9d383916bbb1e2700be8dbb39c7ec9/aioguardian-2025.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9ca91e5b3465fc27bce3d4981facbf5759bd0d9ffde5b34fee43fbd577f40b6b",
"md5": "ab2872d3cea4e90ea1765bf8142ce702",
"sha256": "4e3e7890cf063f73957da872af9a1bbe2e0fa3d7352cc21b5833903315bb4b10"
},
"downloads": -1,
"filename": "aioguardian-2025.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ab2872d3cea4e90ea1765bf8142ce702",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 13682,
"upload_time": "2025-02-04T19:36:48",
"upload_time_iso_8601": "2025-02-04T19:36:48.240624Z",
"url": "https://files.pythonhosted.org/packages/9c/a9/1e5b3465fc27bce3d4981facbf5759bd0d9ffde5b34fee43fbd577f40b6b/aioguardian-2025.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 19:36:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aioguardian"
}
