Skip to main content

API library for the go-eCharger.

Project description

Go-eCharger API

workflow workflow PyPI version

A python API to access the Go-eCharger wallbox. Official Go-eCharger API documentation.

Installing the library locally

python3 -m pip install -e .

This is needed for the first time when working with the library/examples/tests.

Example usage

GOE_API_URL="https://REPLACE_ME.api.v3.go-e.io" GOE_API_TOKEN="REPLACE_ME" python3 examples/simple.py

or

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

python3 -m pip install -r requirements.txt
pre-commit install -t pre-push

Linting

pylint tests/*.py src/**/*.py

Unit testing

pytest

# show logs
pytest -o log_cli=true

# code coverage
pytest --durations=10 --cov-report term-missing --cov=src.goechargerv2 tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smart-energy.goecharger-api-0.3.1.tar.gz (19.2 kB view hashes)

Uploaded Source

Built Distribution

smart_energy.goecharger_api-0.3.1-py3-none-any.whl (18.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page