# AWS CloudFormation Resource Provider Python Plugin
The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.
This plugin library helps to provide Python runtime bindings for the execution of your providers by CloudFormation.
## AWS CloudFormation Resource Provider Python Plugin
The CloudFormation Resource Provider Development Kit (RPDK) allows you to author your own resource providers that can be used by CloudFormation.
This plugin library helps to provide runtime bindings for the execution of your providers by CloudFormation.
[](https://travis-ci.com/aws-cloudformation/cloudformation-cli-python-plugin)
## Community
Join us on Discord! Connect & interact with CloudFormation developers &
experts, find channels to discuss and get help for our CLIs, cfn-lint, CloudFormation registry, StackSets,
Guard and more:
[](https://discord.gg/9zpd7TTRwq)
Installation
------------
```bash
pip install cloudformation-cli-python-plugin
```
Howto
-----
```
$ cfn init
Initializing new project
What's the name of your resource type?
(Organization::Service::Resource)
>> Foo::Bar::Baz
Select a language for code generation:
[1] java
[2] csharp
[3] python38
[4] python39
[5] python310
[6] python311
[7] python312
(enter an integer):
>> 4
Use docker for platform-independent packaging (Y/n)?
This is highly recommended unless you are experienced
with cross-platform Python packaging.
>> y
Initialized a new project in <>
$ cfn submit --dry-run
$ cat <<EOT > test.json
{
"credentials": {
"accessKeyId": "",
"secretAccessKey": "",
"sessionToken": ""
},
"action": "CREATE",
"request": {
"clientRequestToken": "ecba020e-b2e6-4742-a7d0-8a06ae7c4b2b",
"desiredResourceState": {
"Title": "This_Is_The_Title_For_My_Example",
"TestCode": "NOT_STARTED"
},
"previousResourceState": null,
"logicalResourceIdentifier": null
},
"callbackContext": null
}
EOT
$ sam local invoke TestEntrypoint --event test.json
```
Development
-----------
For changes to the plugin, a Python virtual environment is recommended. The development requirements can be sourced from the core repository:
```
python3 -m venv env
source env/bin/activate
pip install -e . -e src/ \
-r https://raw.githubusercontent.com/aws-cloudformation/aws-cloudformation-rpdk/master/requirements.txt
pre-commit install
```
Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit. The continuous integration also runs these checks. Manual options are available so you don't have to commit):
```
# run all hooks on all files, mirrors what the CI runs
pre-commit run --all-files
# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local
pre-commit run pytest-local
```
License
-------
This library is licensed under the Apache 2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk-python-plugin/",
"name": "cloudformation-cli-python-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Amazon Web Services AWS CloudFormation",
"author": "Amazon Web Services",
"author_email": "aws-cloudformation-developers@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/ac/ee/cd6078cf90f516d0a12950fe554015a55a771527140f8a57519bc744e25f/cloudformation-cli-python-plugin-2.1.9.tar.gz",
"platform": null,
"description": "# AWS CloudFormation Resource Provider Python Plugin\n\nThe CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.\n\nThis plugin library helps to provide Python runtime bindings for the execution of your providers by CloudFormation.\n\n## AWS CloudFormation Resource Provider Python Plugin\n\nThe CloudFormation Resource Provider Development Kit (RPDK) allows you to author your own resource providers that can be used by CloudFormation.\n\nThis plugin library helps to provide runtime bindings for the execution of your providers by CloudFormation.\n\n[](https://travis-ci.com/aws-cloudformation/cloudformation-cli-python-plugin)\n\n## Community\n\nJoin us on Discord! Connect & interact with CloudFormation developers &\nexperts, find channels to discuss and get help for our CLIs, cfn-lint, CloudFormation registry, StackSets,\nGuard and more:\n\n[](https://discord.gg/9zpd7TTRwq)\n\nInstallation\n------------\n\n```bash\npip install cloudformation-cli-python-plugin\n```\n\nHowto\n-----\n\n```\n$ cfn init\nInitializing new project\nWhat's the name of your resource type?\n(Organization::Service::Resource)\n>> Foo::Bar::Baz\nSelect a language for code generation:\n[1] java\n[2] csharp\n[3] python38\n[4] python39\n[5] python310\n[6] python311\n[7] python312\n(enter an integer):\n>> 4\nUse docker for platform-independent packaging (Y/n)?\nThis is highly recommended unless you are experienced\nwith cross-platform Python packaging.\n>> y\nInitialized a new project in <>\n$ cfn submit --dry-run\n$ cat <<EOT > test.json\n{\n \"credentials\": {\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"sessionToken\": \"\"\n },\n \"action\": \"CREATE\",\n \"request\": {\n \"clientRequestToken\": \"ecba020e-b2e6-4742-a7d0-8a06ae7c4b2b\",\n \"desiredResourceState\": {\n \"Title\": \"This_Is_The_Title_For_My_Example\",\n \"TestCode\": \"NOT_STARTED\"\n },\n \"previousResourceState\": null,\n \"logicalResourceIdentifier\": null\n },\n \"callbackContext\": null\n}\nEOT\n$ sam local invoke TestEntrypoint --event test.json\n```\n\nDevelopment\n-----------\n\nFor changes to the plugin, a Python virtual environment is recommended. The development requirements can be sourced from the core repository:\n\n```\npython3 -m venv env\nsource env/bin/activate\npip install -e . -e src/ \\\n -r https://raw.githubusercontent.com/aws-cloudformation/aws-cloudformation-rpdk/master/requirements.txt\npre-commit install\n```\n\nLinting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit. The continuous integration also runs these checks. Manual options are available so you don't have to commit):\n\n```\n# run all hooks on all files, mirrors what the CI runs\npre-commit run --all-files\n# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local\npre-commit run pytest-local\n```\n\nLicense\n-------\n\nThis library is licensed under the Apache 2.0 License.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python 3.6 and 3.7 language support for the CloudFormation CLI",
"version": "2.1.9",
"project_urls": {
"Homepage": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk-python-plugin/"
},
"split_keywords": [
"amazon",
"web",
"services",
"aws",
"cloudformation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55aa8be18986554cdd850faafa167e39fbc384ebb0532165ef6d813e1f4dc5ee",
"md5": "4218cd45889a81417b9597d09231b5c1",
"sha256": "c05f699464dadf39856fde49f46a01e976188bcfb6e2f2f803c17feaf6375dfd"
},
"downloads": -1,
"filename": "cloudformation_cli_python_plugin-2.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4218cd45889a81417b9597d09231b5c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21816,
"upload_time": "2024-04-18T17:41:24",
"upload_time_iso_8601": "2024-04-18T17:41:24.288362Z",
"url": "https://files.pythonhosted.org/packages/55/aa/8be18986554cdd850faafa167e39fbc384ebb0532165ef6d813e1f4dc5ee/cloudformation_cli_python_plugin-2.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aceecd6078cf90f516d0a12950fe554015a55a771527140f8a57519bc744e25f",
"md5": "fa5c0e6fc7079036099544d92f2a3fda",
"sha256": "791824f05ee9f8e1fcb790346942769c24320d3986ac9a301adddc1a00b106e6"
},
"downloads": -1,
"filename": "cloudformation-cli-python-plugin-2.1.9.tar.gz",
"has_sig": false,
"md5_digest": "fa5c0e6fc7079036099544d92f2a3fda",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17627,
"upload_time": "2024-04-18T17:41:25",
"upload_time_iso_8601": "2024-04-18T17:41:25.474944Z",
"url": "https://files.pythonhosted.org/packages/ac/ee/cd6078cf90f516d0a12950fe554015a55a771527140f8a57519bc744e25f/cloudformation-cli-python-plugin-2.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 17:41:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-cloudformation",
"github_project": "aws-cloudformation-rpdk-python-plugin",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "cloudformation-cli-python-plugin"
}
JSON
