# smarthome-meterportal
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0
- Package version: 1.0.0
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.8+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import smarthome_meterportal
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import smarthome_meterportal
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import smarthome_meterportal
from smarthome_meterportal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = smarthome_meterportal.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
async with smarthome_meterportal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = smarthome_meterportal.HomeAssistantApi(api_client)
auth_request = smarthome_meterportal.AuthRequest() # AuthRequest | (optional)
try:
api_response = await api_instance.api_homeassistant_authenticate_post(auth_request=auth_request)
print("The response of HomeAssistantApi->api_homeassistant_authenticate_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling HomeAssistantApi->api_homeassistant_authenticate_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*HomeAssistantApi* | [**api_homeassistant_authenticate_post**](docs/HomeAssistantApi.md#api_homeassistant_authenticate_post) | **POST** /api/homeassistant/authenticate |
*HomeAssistantApi* | [**api_homeassistant_full_post**](docs/HomeAssistantApi.md#api_homeassistant_full_post) | **POST** /api/homeassistant/full |
*HomeAssistantApi* | [**api_homeassistant_meters_get**](docs/HomeAssistantApi.md#api_homeassistant_meters_get) | **GET** /api/homeassistant/meters |
*HomeAssistantApi* | [**api_homeassistant_partial_post**](docs/HomeAssistantApi.md#api_homeassistant_partial_post) | **POST** /api/homeassistant/partial |
*HomeyApi* | [**api_homey_authenticate_post**](docs/HomeyApi.md#api_homey_authenticate_post) | **POST** /api/homey/authenticate |
*HomeyApi* | [**api_homey_full_post**](docs/HomeyApi.md#api_homey_full_post) | **POST** /api/homey/full |
*HomeyApi* | [**api_homey_meters_get**](docs/HomeyApi.md#api_homey_meters_get) | **GET** /api/homey/meters |
*HomeyApi* | [**api_homey_partial_post**](docs/HomeyApi.md#api_homey_partial_post) | **POST** /api/homey/partial |
## Documentation For Models
- [AuthRequest](docs/AuthRequest.md)
- [AuthResponse](docs/AuthResponse.md)
- [FullRequest](docs/FullRequest.md)
- [MeterReadingData](docs/MeterReadingData.md)
- [MeterReadingResponse](docs/MeterReadingResponse.md)
- [MeterReadingResponseData](docs/MeterReadingResponseData.md)
- [MetersResponse](docs/MetersResponse.md)
- [PartialRequest](docs/PartialRequest.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ApiKey"></a>
### ApiKey
- **Type**: API key
- **API key parameter name**: X-API-KEY
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "smarthome-meterportal",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, SmartHome",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/04/c3/e4cf6ed659f4698c48a4e17155301ac271b6d95dbf55229521db49ac115a/smarthome_meterportal-1.0.2.tar.gz",
"platform": null,
"description": "# smarthome-meterportal\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 1.0.0\n- Generator version: 7.10.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport smarthome_meterportal\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport smarthome_meterportal\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport smarthome_meterportal\nfrom smarthome_meterportal.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = smarthome_meterportal.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nasync with smarthome_meterportal.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = smarthome_meterportal.HomeAssistantApi(api_client)\n auth_request = smarthome_meterportal.AuthRequest() # AuthRequest | (optional)\n\n try:\n api_response = await api_instance.api_homeassistant_authenticate_post(auth_request=auth_request)\n print(\"The response of HomeAssistantApi->api_homeassistant_authenticate_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling HomeAssistantApi->api_homeassistant_authenticate_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*HomeAssistantApi* | [**api_homeassistant_authenticate_post**](docs/HomeAssistantApi.md#api_homeassistant_authenticate_post) | **POST** /api/homeassistant/authenticate | \n*HomeAssistantApi* | [**api_homeassistant_full_post**](docs/HomeAssistantApi.md#api_homeassistant_full_post) | **POST** /api/homeassistant/full | \n*HomeAssistantApi* | [**api_homeassistant_meters_get**](docs/HomeAssistantApi.md#api_homeassistant_meters_get) | **GET** /api/homeassistant/meters | \n*HomeAssistantApi* | [**api_homeassistant_partial_post**](docs/HomeAssistantApi.md#api_homeassistant_partial_post) | **POST** /api/homeassistant/partial | \n*HomeyApi* | [**api_homey_authenticate_post**](docs/HomeyApi.md#api_homey_authenticate_post) | **POST** /api/homey/authenticate | \n*HomeyApi* | [**api_homey_full_post**](docs/HomeyApi.md#api_homey_full_post) | **POST** /api/homey/full | \n*HomeyApi* | [**api_homey_meters_get**](docs/HomeyApi.md#api_homey_meters_get) | **GET** /api/homey/meters | \n*HomeyApi* | [**api_homey_partial_post**](docs/HomeyApi.md#api_homey_partial_post) | **POST** /api/homey/partial | \n\n\n## Documentation For Models\n\n - [AuthRequest](docs/AuthRequest.md)\n - [AuthResponse](docs/AuthResponse.md)\n - [FullRequest](docs/FullRequest.md)\n - [MeterReadingData](docs/MeterReadingData.md)\n - [MeterReadingResponse](docs/MeterReadingResponse.md)\n - [MeterReadingResponseData](docs/MeterReadingResponseData.md)\n - [MetersResponse](docs/MetersResponse.md)\n - [PartialRequest](docs/PartialRequest.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKey\"></a>\n### ApiKey\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "SmartHome",
"version": "1.0.2",
"project_urls": {
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" smarthome"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c39d2841b56ac34430a8a9b7ede21d0a17718024621f0eef0e88ba649b33408",
"md5": "20ca78a574c76766706462ba3174ff77",
"sha256": "71bcc24407d8460065cf4958c56d7c131bd8b705db8c2ad03c6e31b7d38af70e"
},
"downloads": -1,
"filename": "smarthome_meterportal-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20ca78a574c76766706462ba3174ff77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 36777,
"upload_time": "2025-01-14T13:44:58",
"upload_time_iso_8601": "2025-01-14T13:44:58.548710Z",
"url": "https://files.pythonhosted.org/packages/0c/39/d2841b56ac34430a8a9b7ede21d0a17718024621f0eef0e88ba649b33408/smarthome_meterportal-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04c3e4cf6ed659f4698c48a4e17155301ac271b6d95dbf55229521db49ac115a",
"md5": "606a31992dd68a40ac9370d8be9afa22",
"sha256": "709a02f97832ad8e312b81d72662a02f89a8935ec1f97fd3d01b195fc17ce2da"
},
"downloads": -1,
"filename": "smarthome_meterportal-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "606a31992dd68a40ac9370d8be9afa22",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 23452,
"upload_time": "2025-01-14T13:45:01",
"upload_time_iso_8601": "2025-01-14T13:45:01.495116Z",
"url": "https://files.pythonhosted.org/packages/04/c3/e4cf6ed659f4698c48a4e17155301ac271b6d95dbf55229521db49ac115a/smarthome_meterportal-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 13:45:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "smarthome-meterportal"
}
JSON
