ev-recharge-sdk

Name	ev-recharge-sdk JSON
Version	1.2.0 JSON
	download
home_page	None
Summary	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.
upload_time	2024-07-24 12:38:07
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	None
keywords	ev charging shell apimatic sdk apis recharge locations
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
# 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](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:

```python
pip install ev-recharge-sdk==1.2.0
```

You can also view the package at:
https://pypi.python.org/pypi/ev-recharge-sdk/1.2.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.](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **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. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ['GET', 'PUT']** |
| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |

The API client can be initialized as follows:

```python
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.

* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md)

## List of APIs

* [Locations](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/controllers/locations.md)
* [Charging](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/controllers/charging.md)

## Classes Documentation

* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/http-request.md)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ev-recharge-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "EV, Charging, Shell, APIMatic, SDK, APIs, Recharge, locations",
    "author": null,
    "author_email": "developer sdksio <developer+sdksio@apimatic.io>",
    "download_url": "https://files.pythonhosted.org/packages/dd/8a/3eac57bd69a0b548ea25c3bf6e2dada905435b6b318d074d8f632910f09a/ev_recharge_sdk-1.2.0.tar.gz",
    "platform": null,
    "description": "\n# Getting Started with Shell EV\n\n## Introduction\n\nThis 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.\n\nSupported Functions\n\n* Get the list of all the locations and its details.\n* Get the details of a particular location.\n* Get the list of locations nearby using the latitude and longitude.\n* Get the list of locations for a given set of bounds with different zoom levels.\n\nThe Charging endpoints provides control to start, stop and get status of the charging session.\n\nSupported Functions\n\n* Start a charging session\\n\n* Stop a charging session \\n\n* Retrieve the status of a charging session \\n\n* Retrieve the list of all active sessions for a card\n\nGo to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install ev-recharge-sdk==1.2.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/ev-recharge-sdk/1.2.0\n\n## Test the SDK\n\nYou 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:\n\nNavigate to the root directory of the SDK and run the following commands\n\n```\npip install -r test-requirements.txt\npytest\n```\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |\n\nThe API client can be initialized as follows:\n\n```python\nclient = ShellevClient(\n    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(\n        o_auth_client_id='OAuthClientId',\n        o_auth_client_secret='OAuthClientSecret'\n    )\n)\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n|  --- | --- |\n| production | **Default** Production |\n| environment2 | Test |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/oauth-2-client-credentials-grant.md)\n\n## List of APIs\n\n* [Locations](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/controllers/locations.md)\n* [Charging](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/controllers/charging.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.2.0/doc/http-request.md)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "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.",
    "version": "1.2.0",
    "project_urls": {
        "Documentation": "https://developer.shell.com/product-catalog/shell-recharge/sdk#/http/setting-up-sdks"
    },
    "split_keywords": [
        "ev",
        " charging",
        " shell",
        " apimatic",
        " sdk",
        " apis",
        " recharge",
        " locations"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c13a5874c443446651e61b900ecace5f509b6a76411230edda10c77921bbfa24",
                "md5": "6965a35aa3c6ac53010cd91905e5c775",
                "sha256": "53424b4fa9bb4d97eb987bdf50a50df0035b6e6960f419910a4638c45f3abb91"
            },
            "downloads": -1,
            "filename": "ev_recharge_sdk-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6965a35aa3c6ac53010cd91905e5c775",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 81882,
            "upload_time": "2024-07-24T12:38:05",
            "upload_time_iso_8601": "2024-07-24T12:38:05.766926Z",
            "url": "https://files.pythonhosted.org/packages/c1/3a/5874c443446651e61b900ecace5f509b6a76411230edda10c77921bbfa24/ev_recharge_sdk-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd8a3eac57bd69a0b548ea25c3bf6e2dada905435b6b318d074d8f632910f09a",
                "md5": "592dabf0dcf9f5fe2cb9c410232902a2",
                "sha256": "c34df7810bc0c56853dca94d268564952b1837b35c95f18d4929d7ad5f51e54c"
            },
            "downloads": -1,
            "filename": "ev_recharge_sdk-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "592dabf0dcf9f5fe2cb9c410232902a2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 33795,
            "upload_time": "2024-07-24T12:38:07",
            "upload_time_iso_8601": "2024-07-24T12:38:07.213223Z",
            "url": "https://files.pythonhosted.org/packages/dd/8a/3eac57bd69a0b548ea25c3bf6e2dada905435b6b318d074d8f632910f09a/ev_recharge_sdk-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-24 12:38:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ev-recharge-sdk"
}

None