Skip to content

Update README to use public released plugin #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wbingli merged 1 commit into from
Jun 30, 2020
Merged

Update README to use public released plugin #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# DEVELOPER PREVIEW
# AWS CloudFormation Resource Provider Python Plugin

We're excited to share our progress with adding new languages to the CloudFormation CLI! This plugin is an early preview, and not ready for production use.
The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.

@priyap286 priyap286 Jun 30, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence kind of feels incomplete. You can probably add something like,
"...that can be used by CloudFormation to Create/Update/Delete your resource."


This plugin library helps to provide Python runtime bindings for the execution of your providers by CloudFormation.

## AWS CloudFormation Resource Provider Python Plugin

Expand All @@ -13,18 +15,13 @@ This plugin library helps to provide runtime bindings for the execution of your
Installation
------------

Because this is a developer preview, you can't install it from pypi (the version there will not work)
You can still install the plugin using [pip](https://pypi.org/project/pip/) from GitHub.

```bash
pip install git+https://github.com/aws-cloudformation/aws-cloudformation-rpdk-python-plugin.git#egg=cloudformation-cli-python-plugin
pip install cloudformation-cli-python-plugin
```

Howto
-----

The support library, `cloudformation-cli-python-lib` must be packaged and present in the project's directory. Packaging can be done by running the `package_lib.sh` script. Example run:

```
$ cfn init
Initializing new project
Expand All @@ -43,7 +40,6 @@ This is highly recommended unless you are experienced
with cross-platform Python packaging.
>> y
Initialized a new project in <>
$ cp ../cloudformation-cli-python-lib-0.0.1.tar.gz .
$ cfn submit --dry-run
$ cat <<EOT > test.json
{
Expand Down
7 changes: 0 additions & 7 deletions package_lib.sh
View file
Open in desktop

This file was deleted.