Skip to main content

This API Product provides the option to manage charging at all public Shell Recharge locations. The end points provides control to start, stop and get status of the charging session.

Project description

Getting Started with Shell EV

Introduction

This API Product provides the list of all Shell Recharge locations. The list includes all Shell Recharge network and all locations available through our roaming partners.

Supported Functions

  • Get the list of all the locations and its details.
  • Get the details of a particular location.
  • Get the list of locations nearby using the latitude and longitude.
  • Get the list of locations for a given set of bounds with different zoom levels.

The Charging endpoints provides control to start, stop and get status of the charging session.

Supported Functions

  • Start a charging session\n
  • Stop a charging session \n
  • Retrieve the status of a charging session \n
  • Retrieve the list of all active sessions for a card

Go to the Shell Developer Portal: https://developer.shell.com

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install ev-recharge-sdk==1.1.0

You can also view the package at: https://pypi.python.org/pypi/ev-recharge-sdk/1.1.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = ShellevClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret'
    )
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
production Default Production
environment2 Test

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

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

ev_recharge_sdk-1.1.0.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

ev_recharge_sdk-1.1.0-py3-none-any.whl (81.5 kB view details)

Uploaded Python 3

File details

Details for the file ev_recharge_sdk-1.1.0.tar.gz.

File metadata

  • Download URL: ev_recharge_sdk-1.1.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.13

File hashes

Hashes for ev_recharge_sdk-1.1.0.tar.gz
Algorithm Hash digest
SHA256 94c1e59144a853e34966be3815a2aff247d1e93f30d0bf9d02e612e8c5ac148e
MD5 413e1df0df7284ed7945a151397d4387
BLAKE2b-256 1ac55b300aefd249364655d14e79dd164043d16ad9a56627d97a6ebbbacd52fb

See more details on using hashes here.

File details

Details for the file ev_recharge_sdk-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ev_recharge_sdk-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c63ff7a05853a49d786d72b98863964c6db1f18345bf0b3214dd58ceb5fab6db
MD5 a9cec397eb0e2ef5d31b5819a946af9a
BLAKE2b-256 edbe457f50a09c7a24939d0db941e5a2e274651b5ecc26983b39a9056912965c

See more details on using hashes here.

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