| Name | smart-energy.goecharger-api JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | API library for the go-eCharger. |
| upload_time | 2023-01-11 07:38:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
goecharger
kfw
api
cloud
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Go-eCharger API
A python API to access the Go-eCharger wallbox. Official Go-eCharger [API documentation](https://github.com/goecharger/go-eCharger-API-v2).
## Installing the library locally
```bash
python3 -m pip install -e .
```
> __This is needed for the first time when working with the library/examples/tests.__
## Example usage
```bash
GOE_API_URL="https://REPLACE_ME.api.v3.go-e.io" GOE_API_TOKEN="REPLACE_ME" python3 examples/simple.py
```
or
```python
from goechargerv2.goecharger import GoeChargerApi
charger = GoeChargerApi('provide_api_url', 'provide_api_token')
# or you can define additional optional parameters
# charger = GoeChargerApi('provide_api_url', 'provide_api_token', timeout=10, wait=True)
print(charger.request_status())
```
## Development
## Install required pip packages
```bash
python3 -m pip install -r requirements.txt
pre-commit install -t pre-push
```
### Linting
```bash
pylint tests/*.py src/**/*.py
```
### Unit testing
```bash
pytest
# show logs
pytest -o log_cli=true
# code coverage
pytest --durations=10 --cov-report term-missing --cov=src.goechargerv2 tests
```
Raw data
{
"_id": null,
"home_page": "",
"name": "smart-energy.goecharger-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "goecharger,kfw,api,cloud",
"author": "",
"author_email": "Ingmar Mueller <ingmar.mueller@kfw.de>, Mario Macai <mario.macai@accenture.com>",
"download_url": "https://files.pythonhosted.org/packages/d0/dc/71f51d1b4316c46fb7a35071580948457ec6fc11a988cc8ce974d9f9df64/smart-energy.goecharger-api-0.3.1.tar.gz",
"platform": null,
"description": "# Go-eCharger API\n\n\n\n\n\nA python API to access the Go-eCharger wallbox. Official Go-eCharger [API documentation](https://github.com/goecharger/go-eCharger-API-v2).\n\n## Installing the library locally\n\n```bash\npython3 -m pip install -e .\n```\n\n> __This is needed for the first time when working with the library/examples/tests.__\n\n## Example usage\n\n```bash\nGOE_API_URL=\"https://REPLACE_ME.api.v3.go-e.io\" GOE_API_TOKEN=\"REPLACE_ME\" python3 examples/simple.py\n```\n\nor\n\n```python\nfrom goechargerv2.goecharger import GoeChargerApi\n\ncharger = GoeChargerApi('provide_api_url', 'provide_api_token')\n# or you can define additional optional parameters\n# charger = GoeChargerApi('provide_api_url', 'provide_api_token', timeout=10, wait=True)\n \nprint(charger.request_status())\n```\n\n## Development\n\n## Install required pip packages\n\n```bash\npython3 -m pip install -r requirements.txt\npre-commit install -t pre-push\n```\n\n### Linting\n\n```bash\npylint tests/*.py src/**/*.py\n```\n\n### Unit testing\n\n```bash\npytest\n\n# show logs\npytest -o log_cli=true\n\n# code coverage\npytest --durations=10 --cov-report term-missing --cov=src.goechargerv2 tests\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "API library for the go-eCharger.",
"version": "0.3.1",
"split_keywords": [
"goecharger",
"kfw",
"api",
"cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8746c1b6bb2b21449c6e6f15af8843d3202cda3b8adf4a5f18bdc0850631bb8f",
"md5": "b135de0341085348fc93cac088a16b65",
"sha256": "e2b5b963e7b125bdfccfb99678aa78b032ded2e550867b06c009e80bae3fd56b"
},
"downloads": -1,
"filename": "smart_energy.goecharger_api-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b135de0341085348fc93cac088a16b65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18910,
"upload_time": "2023-01-11T07:38:39",
"upload_time_iso_8601": "2023-01-11T07:38:39.215136Z",
"url": "https://files.pythonhosted.org/packages/87/46/c1b6bb2b21449c6e6f15af8843d3202cda3b8adf4a5f18bdc0850631bb8f/smart_energy.goecharger_api-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0dc71f51d1b4316c46fb7a35071580948457ec6fc11a988cc8ce974d9f9df64",
"md5": "35a48d2fde24fcdf933cc2ba04ebddbc",
"sha256": "90006748d71fecdf5ec2e4eaed53641a6de97e50e69f8b66f1a6c963f7a77f52"
},
"downloads": -1,
"filename": "smart-energy.goecharger-api-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "35a48d2fde24fcdf933cc2ba04ebddbc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19188,
"upload_time": "2023-01-11T07:38:40",
"upload_time_iso_8601": "2023-01-11T07:38:40.425720Z",
"url": "https://files.pythonhosted.org/packages/d0/dc/71f51d1b4316c46fb7a35071580948457ec6fc11a988cc8ce974d9f9df64/smart-energy.goecharger-api-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 07:38:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "smart-energy.goecharger-api"
}
