No project description provided
AWS CloudFormation Resource Provider Go 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 Go runtime bindings for the execution of your providers by CloudFormation.
If you are using this package to build resource providers for CloudFormation, install the CloudFormation CLI Go Plugin - this will automatically install the the CloudFormation CLI! A Python virtual environment is recommended.
pip3 install cloudformation-cli-go-plugin
Refer to the documentation for the CloudFormation CLI for usage instructions.
For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:
python3 -m venv env source env/bin/activate pip3 install -e /path/to/cloudformation-cli-go-plugin
You may also want to check out the CloudFormation CLI if you wish to make edits to that. In this case, installing them in one operation works well:
pip3 install \ -e /path/to/cloudformation-cli \ -e /path/to/cloudformation-cli-go-plugin
That ensures neither is accidentally installed from PyPI.
Linting and running unit tests is done via pre-commit, 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, isort, pytest-local pre-commit run pytest-local
./generate-examples.sh to run install
cloudformation-cli-go-plugin locally and run
cfn generate in each example.
This library is licensed under the Apache 2.0 License.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size cloudformation_cli_go_plugin-2.0.4-py3-none-any.whl (16.0 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size cloudformation-cli-go-plugin-2.0.4.tar.gz (13.8 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for cloudformation_cli_go_plugin-2.0.4-py3-none-any.whl
Hashes for cloudformation-cli-go-plugin-2.0.4.tar.gz