# 🚰 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.10
- Python 3.11
- Python 3.12
# 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://github.com/bachya/aioguardian/workflows/CI/badge.svg
[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": "https://github.com/bachya/aioguardian",
"name": "aioguardian",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Aaron Bach",
"author_email": "bachya1208@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/f4/1b23003ad60b1bea087583f40eb13a3a5b7733fd0aab198b2bfecc956b56/aioguardian-2023.12.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.10\n- Python 3.11\n- Python 3.12\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://github.com/bachya/aioguardian/workflows/CI/badge.svg\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python3 library for Elexa Guardian water valves and sensors",
"version": "2023.12.0",
"project_urls": {
"Bug Tracker": "https://github.com/bachya/aioguardian/issues",
"Changelog": "https://github.com/bachya/aioguardian/releases",
"Homepage": "https://github.com/bachya/aioguardian",
"Repository": "https://github.com/bachya/aioguardian"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6afd4a52324dcea4b126b087802a9d4acd6a0441666150f3a8692a001717ff0a",
"md5": "9752f82416fabd1d0e430dd4385d5f98",
"sha256": "a0d2fd213f8a4bde695513a5dcaa06b82d00beba888e94cbe76abc04eb11dc21"
},
"downloads": -1,
"filename": "aioguardian-2023.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9752f82416fabd1d0e430dd4385d5f98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 14387,
"upload_time": "2023-12-18T02:14:20",
"upload_time_iso_8601": "2023-12-18T02:14:20.319521Z",
"url": "https://files.pythonhosted.org/packages/6a/fd/4a52324dcea4b126b087802a9d4acd6a0441666150f3a8692a001717ff0a/aioguardian-2023.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3f41b23003ad60b1bea087583f40eb13a3a5b7733fd0aab198b2bfecc956b56",
"md5": "e21384f1cf62bc60319cb38fe933dad9",
"sha256": "0660bcafd56734a0764f867dedc2b29e5a4373ace204665f56732b38650b8ef2"
},
"downloads": -1,
"filename": "aioguardian-2023.12.0.tar.gz",
"has_sig": false,
"md5_digest": "e21384f1cf62bc60319cb38fe933dad9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 11046,
"upload_time": "2023-12-18T02:14:21",
"upload_time_iso_8601": "2023-12-18T02:14:21.991768Z",
"url": "https://files.pythonhosted.org/packages/a3/f4/1b23003ad60b1bea087583f40eb13a3a5b7733fd0aab198b2bfecc956b56/aioguardian-2023.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 02:14:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bachya",
"github_project": "aioguardian",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aioguardian"
}
JSON
