alphaess-aio


Namealphaess-aio JSON
Version 0.0.0 PyPI version JSON
download
home_pageNone
SummarySends get and post requests to available AlphaCloud API endpoints.
upload_time2024-11-17 21:12:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 zeguramente Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords alphaess api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Alphaess-aio - a Alpha Open API client

## About

Sends get and post requests to available AlphaCloud API endpoints and retrieves data about you AlphaESS system.
Code generated out of API description.

## Prerequisites

Register account at https://open.alphaess.com/. You will recieve an AppID and AppSecret needed for authentification.

## How to use

```python
import asyncio
from alphaessaio import AlphaEssAPI, AlphaEssAuth

# setup auth
auth = AlphaEssAuth(appid="your_app_id", appsecret="your_app_secret")

#init api
alphaess_api = AlphaEssAPI(auth)

ess_list = asyncio.run(alphaess_api.get_ess_list())
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "alphaess-aio",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Markus Ziegler <frage_n@web.de>",
    "keywords": "alphaess, api",
    "author": null,
    "author_email": "Markus Ziegler <frage_n@web.de>",
    "download_url": "https://files.pythonhosted.org/packages/ce/04/682e99a2211fe4594eee34a234880ec93ba499bec0e5df94031894598e3d/alphaess_aio-0.0.0.tar.gz",
    "platform": null,
    "description": "# Alphaess-aio - a Alpha Open API client\n\n## About\n\nSends get and post requests to available AlphaCloud API endpoints and retrieves data about you AlphaESS system.\nCode generated out of API description.\n\n## Prerequisites\n\nRegister account at https://open.alphaess.com/. You will recieve an AppID and AppSecret needed for authentification.\n\n## How to use\n\n```python\nimport asyncio\nfrom alphaessaio import AlphaEssAPI, AlphaEssAuth\n\n# setup auth\nauth = AlphaEssAuth(appid=\"your_app_id\", appsecret=\"your_app_secret\")\n\n#init api\nalphaess_api = AlphaEssAPI(auth)\n\ness_list = asyncio.run(alphaess_api.get_ess_list())\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 zeguramente  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Sends get and post requests to available AlphaCloud API endpoints.",
    "version": "0.0.0",
    "project_urls": {
        "Repository": "https://github.com/zeguramente/alphaess-aio"
    },
    "split_keywords": [
        "alphaess",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "09b02bb5a28c3568b61bbae2ce48b6bbdbb378e02f1db5d10e056f50a1b10ae6",
                "md5": "17e05dcebfb4846547f508972f8bdbaf",
                "sha256": "b1da20606c6d6498a60a769ef071051ba18fe975450d0601574d368b6c57cc1f"
            },
            "downloads": -1,
            "filename": "alphaess_aio-0.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "17e05dcebfb4846547f508972f8bdbaf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 8901,
            "upload_time": "2024-11-17T21:12:02",
            "upload_time_iso_8601": "2024-11-17T21:12:02.722367Z",
            "url": "https://files.pythonhosted.org/packages/09/b0/2bb5a28c3568b61bbae2ce48b6bbdbb378e02f1db5d10e056f50a1b10ae6/alphaess_aio-0.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce04682e99a2211fe4594eee34a234880ec93ba499bec0e5df94031894598e3d",
                "md5": "af9cc69160bdf53454aa063cca0f02b0",
                "sha256": "84076a27a1ca5ee3077813333a4cc4457b43b1a06ba8be9453bdefcb693d6379"
            },
            "downloads": -1,
            "filename": "alphaess_aio-0.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af9cc69160bdf53454aa063cca0f02b0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8820,
            "upload_time": "2024-11-17T21:12:04",
            "upload_time_iso_8601": "2024-11-17T21:12:04.531516Z",
            "url": "https://files.pythonhosted.org/packages/ce/04/682e99a2211fe4594eee34a234880ec93ba499bec0e5df94031894598e3d/alphaess_aio-0.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-17 21:12:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zeguramente",
    "github_project": "alphaess-aio",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "alphaess-aio"
}
        
Elapsed time: 2.02801s