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-0.1.5.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: cloudformation-cli-go-plugin-0.1.5.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.5

File hashes

Hashes for cloudformation-cli-go-plugin-0.1.5.tar.gz
Algorithm Hash digest
SHA256 05528056eb9b5f428827e5a7e8e50c99c1dbddecc62ec4e0cd9805913414bf31
MD5 4d507cf2c70a315719dea269e10041fa
BLAKE2b-256 4634ff5e56aea99925abe5462e4df319c54186cc1344d89ea7791fd880614037

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudformation_cli_go_plugin-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.5

File hashes

Hashes for cloudformation_cli_go_plugin-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c74666d11ee9d5c446dc993f5e7d39e8e3134c90789685df2689934688916377
MD5 43530ad2de71883c19bab505f76d7818
BLAKE2b-256 287f13388f19ca2a21b5c74a502e6dd8f12010dbbcf04a73a1ccac66e0932c97

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