| Name | ev-recharge-sdk JSON |
| Version |
1.0.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-05-28 06:30:35 |
| 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 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.
Supported Function
* Start a charging session
* Stop a charging session
* Retrieve the status of a charging session
* Retrieve the list of all active sessions for a card termsOfService: 'https://developer.shell.com/terms-of-use'
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.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/ev-recharge-sdk/1.0.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.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `env` | `EnvEnum` | This variable specifies the type of environment. Environments:<br><br>* `api` - Production<br>* `api-test` - UAT<br>*Default*: `'api-test.shell.com'` |
| `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.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.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'
)
)
```
## 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.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
## List of APIs
* [O Auth Authorization](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
* [Charging](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/charging.md)
* [Locations](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/locations.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.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/82/ed/2a316c7a77195486d8c03735477a88fca52f36e7bb67bca718653b4784d0/ev_recharge_sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Shell EV\n\n## Introduction\n\nThis 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.\n\nSupported Function\n\n* 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 termsOfService: 'https://developer.shell.com/terms-of-use'\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.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/ev-recharge-sdk/1.0.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.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `env` | `EnvEnum` | This variable specifies the type of environment. Environments:<br><br>* `api` - Production<br>* `api-test` - UAT<br>*Default*: `'api-test.shell.com'` |\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.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.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## 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.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)\n\n## List of APIs\n\n* [O Auth Authorization](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)\n* [Charging](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/charging.md)\n* [Locations](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/controllers/locations.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-python-sdk/tree/1.0.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.0.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": "4806e0c9364fefb6a7d03408de7cb3888cd198311730b666a0364cc70e6d956e",
"md5": "dd6a4723aed1e1030439a7e98b53af90",
"sha256": "db426d15b22d129ce4163f8a6a51708b8165e22356227c796fa15933fa89c7d2"
},
"downloads": -1,
"filename": "ev_recharge_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd6a4723aed1e1030439a7e98b53af90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 97502,
"upload_time": "2024-05-28T06:30:33",
"upload_time_iso_8601": "2024-05-28T06:30:33.979372Z",
"url": "https://files.pythonhosted.org/packages/48/06/e0c9364fefb6a7d03408de7cb3888cd198311730b666a0364cc70e6d956e/ev_recharge_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82ed2a316c7a77195486d8c03735477a88fca52f36e7bb67bca718653b4784d0",
"md5": "775cc71892d050df764636fce716e4cc",
"sha256": "1b0102f1d850e182aeeda16026573e725990d4a8989ae0d59764693a78f087aa"
},
"downloads": -1,
"filename": "ev_recharge_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "775cc71892d050df764636fce716e4cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 34829,
"upload_time": "2024-05-28T06:30:35",
"upload_time_iso_8601": "2024-05-28T06:30:35.898835Z",
"url": "https://files.pythonhosted.org/packages/82/ed/2a316c7a77195486d8c03735477a88fca52f36e7bb67bca718653b4784d0/ev_recharge_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 06:30:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ev-recharge-sdk"
}
