# sceptre-request-resolver
A Sceptre resolver to make requests from REST API endpoints.
## Motivation
There are some pretty useful REST API endpoints on the internet. The endpoints
can return lots of different types of data, typically in JSON format.
This simple resolver can retrieve that data and pass it to Sceptre parameters
or scepter_user_data parameters.
## Installation
To install directly from PyPI
```shell
pip install sceptre-request-resolver
```
To install from this git repo
```shell
pip install git+https://github.com/Sceptre/sceptre-request-resolver.git
```
## Usage/Examples
```yaml
parameters|sceptre_user_data:
<name>: !request <API ENDPOINT>
```
```yaml
parameters|sceptre_user_data:
<name>: !request
url: <API ENDPOINT>
auth: <authentication type>
user: <auth user name>
password: <auth password>
```
__Note__:
* This resolver always returns a string.
* Supported authentication types: `basic`
## Example
Simple request:
```yaml
parameters:
wisdom: !request 'https://ron-swanson-quotes.herokuapp.com/v2/quotes'
```
Request with basic authentication:
```yaml
parameters:
wisdom: !request
url: https://private.endpoint.com/
auth: basic
user: MyUsername
password: MyUserPwd
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Sceptre/sceptre-request-resolver",
"name": "sceptre-request-resolver",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "sceptre,sceptre-resolver",
"author": "Khai Do",
"author_email": "zaro0508@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/68/f4a55691fd78554ed2b3c48bce0756fd45986289e421e05d32c9c98d3457/sceptre_request_resolver-0.4.0.tar.gz",
"platform": null,
"description": "# sceptre-request-resolver\n\nA Sceptre resolver to make requests from REST API endpoints.\n\n## Motivation\n\nThere are some pretty useful REST API endpoints on the internet. The endpoints\ncan return lots of different types of data, typically in JSON format.\nThis simple resolver can retrieve that data and pass it to Sceptre parameters\nor scepter_user_data parameters.\n\n## Installation\n\nTo install directly from PyPI\n```shell\npip install sceptre-request-resolver\n```\n\nTo install from this git repo\n```shell\npip install git+https://github.com/Sceptre/sceptre-request-resolver.git\n```\n\n## Usage/Examples\n\n```yaml\nparameters|sceptre_user_data:\n <name>: !request <API ENDPOINT>\n```\n\n```yaml\nparameters|sceptre_user_data:\n <name>: !request\n url: <API ENDPOINT>\n auth: <authentication type>\n user: <auth user name>\n password: <auth password>\n```\n\n__Note__:\n* This resolver always returns a string.\n* Supported authentication types: `basic`\n\n## Example\n\nSimple request:\n\n```yaml\nparameters:\n wisdom: !request 'https://ron-swanson-quotes.herokuapp.com/v2/quotes'\n```\n\nRequest with basic authentication:\n```yaml\nparameters:\n wisdom: !request\n url: https://private.endpoint.com/\n auth: basic\n user: MyUsername\n password: MyUserPwd\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Sceptre resolver to make requests from REST API endpoints",
"version": "0.4.0",
"split_keywords": [
"sceptre",
"sceptre-resolver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5762f877e22c43846574daf42454b135694d0ac6d780b309e1a1ad31f3604947",
"md5": "e8913abc582005b7122f82c2c0b9e6a0",
"sha256": "c0f3d993e490729457b6889d8808111e8a73ac1dd6da9507a0f962961ecd6a2c"
},
"downloads": -1,
"filename": "sceptre_request_resolver-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8913abc582005b7122f82c2c0b9e6a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 3114,
"upload_time": "2023-04-05T18:06:11",
"upload_time_iso_8601": "2023-04-05T18:06:11.809931Z",
"url": "https://files.pythonhosted.org/packages/57/62/f877e22c43846574daf42454b135694d0ac6d780b309e1a1ad31f3604947/sceptre_request_resolver-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da68f4a55691fd78554ed2b3c48bce0756fd45986289e421e05d32c9c98d3457",
"md5": "1eb96df4f8de33f6f8d1a33772a2000c",
"sha256": "c66f735b17016637636fc8eda8100f4752f55672ab87c38d2b4d46c56e677763"
},
"downloads": -1,
"filename": "sceptre_request_resolver-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "1eb96df4f8de33f6f8d1a33772a2000c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 2833,
"upload_time": "2023-04-05T18:06:13",
"upload_time_iso_8601": "2023-04-05T18:06:13.318534Z",
"url": "https://files.pythonhosted.org/packages/da/68/f4a55691fd78554ed2b3c48bce0756fd45986289e421e05d32c9c98d3457/sceptre_request_resolver-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-05 18:06:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Sceptre",
"github_project": "sceptre-request-resolver",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "sceptre-request-resolver"
}
JSON
