Skip to main content

No project description provided

Project description

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.

Usage

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.

Development

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

Getting started

This plugin create a sample Go project and requires golang 1.8 or above and godep. For more information on installing and setting up your Go environment, please visit the official Golang site.

License

This library is licensed under the Apache 2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudformation-cli-go-plugin-2.0.1.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file cloudformation-cli-go-plugin-2.0.1.tar.gz.

File metadata

  • Download URL: cloudformation-cli-go-plugin-2.0.1.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for cloudformation-cli-go-plugin-2.0.1.tar.gz
Algorithm Hash digest
SHA256 12208adccf99677545c34da1562b5efce5262b13314b3e9ff0d8cb460486b54f
MD5 7329e1d809bde8ef33758dd1888391d6
BLAKE2b-256 d25ed8c591e6a142fdab2e83615b01ec69b5cdea2331858af572a4d1cf965b84

See more details on using hashes here.

File details

Details for the file cloudformation_cli_go_plugin-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: cloudformation_cli_go_plugin-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for cloudformation_cli_go_plugin-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4797f0093cfd6564de4a7699535563007705b5d29db9864d595ac5b26dfee977
MD5 ac6d04509250bea2c8e9bb9287c654af
BLAKE2b-256 5282d453260b0b2fd23ac76af84835be85c300980064a7add269bf0bebaf8b84

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page