Asynchronous Python client for the [PoolCopilot API][poolcopilot-api].
## About
A python package to interact with a [PoolCop][poolcop] device.
## Installation
```bash
pip install poolcop
```
## Usage
```python
import asyncio
import json
from poolcop import PoolCopilot
API_KEY="xxxxxxxxxxxxxxxxxxxxxxx"
async def main() -> None:
"""Show example on fetching the status from PoolCop."""
async with PoolCopilot(api_key=API_KEY) as client:
status = await client.status()
print(json.dumps(status, indent=2))
if __name__ == "__main__":
asyncio.run(main())
```
[poolcop]: https://www.poolcop.com/
[poolcopilot-api]: https://poolcopilot.com/api/docs/
Raw data
{
"_id": null,
"home_page": "https://github.com/sstriker/python-poolcop",
"name": "poolcop",
"maintainer": "Sander Striker",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "s.striker@striker.nl",
"keywords": "poolcop,poolcopilot,api,async,client",
"author": "Sander Striker",
"author_email": "s.striker@striker.nl",
"download_url": "https://files.pythonhosted.org/packages/14/66/fa4e62c41825056b84c945b2f1938b01739413b65da9ae336f4b45505f96/poolcop-0.0.1.tar.gz",
"platform": null,
"description": "Asynchronous Python client for the [PoolCopilot API][poolcopilot-api].\n\n## About\n\nA python package to interact with a [PoolCop][poolcop] device.\n\n## Installation\n\n```bash\npip install poolcop\n```\n\n## Usage\n\n```python\nimport asyncio\nimport json\nfrom poolcop import PoolCopilot\n\nAPI_KEY=\"xxxxxxxxxxxxxxxxxxxxxxx\"\n\nasync def main() -> None:\n \"\"\"Show example on fetching the status from PoolCop.\"\"\"\n async with PoolCopilot(api_key=API_KEY) as client:\n status = await client.status()\n print(json.dumps(status, indent=2))\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n[poolcop]: https://www.poolcop.com/\n[poolcopilot-api]: https://poolcopilot.com/api/docs/\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Asynchronous Python client for the PoolCopilot API",
"version": "0.0.1",
"split_keywords": [
"poolcop",
"poolcopilot",
"api",
"async",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98572cfd48556b79c1433e23b7a6c11b2ca68d450a44863fec456340d6f039e8",
"md5": "f3d95d3b2d79e7a3be8aa9bc352d541b",
"sha256": "6274330037610be435c257066df793b899e0d6b7fdafaef38ee6a1cb3eede941"
},
"downloads": -1,
"filename": "poolcop-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3d95d3b2d79e7a3be8aa9bc352d541b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 8528,
"upload_time": "2023-04-09T16:11:40",
"upload_time_iso_8601": "2023-04-09T16:11:40.124385Z",
"url": "https://files.pythonhosted.org/packages/98/57/2cfd48556b79c1433e23b7a6c11b2ca68d450a44863fec456340d6f039e8/poolcop-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1466fa4e62c41825056b84c945b2f1938b01739413b65da9ae336f4b45505f96",
"md5": "081a0f5480048dcdbba560295a41045c",
"sha256": "375509d96e7a50b3a84ed20e2b897e3f80bfdd9c1030b701643aea49cb1ce760"
},
"downloads": -1,
"filename": "poolcop-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "081a0f5480048dcdbba560295a41045c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 7438,
"upload_time": "2023-04-09T16:11:41",
"upload_time_iso_8601": "2023-04-09T16:11:41.960365Z",
"url": "https://files.pythonhosted.org/packages/14/66/fa4e62c41825056b84c945b2f1938b01739413b65da9ae336f4b45505f96/poolcop-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-09 16:11:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sstriker",
"github_project": "python-poolcop",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "poolcop"
}
JSON
