You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,9 @@ This plugin library helps to provide Java runtime bindings for the execution of
7
7
Usage
8
8
-----
9
9
10
-
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) and the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin)
10
+
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.
11
11
12
12
```shell
13
-
pip3 install cloudformation-cli
14
13
pip3 install cloudformation-cli-java-plugin
15
14
```
16
15
@@ -19,23 +18,25 @@ Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-c
19
18
Development
20
19
-----------
21
20
22
-
First, you will need to install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli), as it is a required dependency:
21
+
For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:
For changes to the plugin, a Python virtual environment is recommended.
29
+
You may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:
29
30
30
31
```shell
31
-
python3 -m venv env
32
-
source env/bin/activate
33
-
# assuming cloudformation-cli has already been cloned/downloaded
34
-
pip3 install -e .
35
-
pre-commit install
32
+
pip3 install \
33
+
-e /path/to/cloudformation-cli \
34
+
-e /path/to/cloudformation-cli-java-plugin
36
35
```
37
36
38
-
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):
37
+
That ensures neither is accidentally installed from PyPI.
38
+
39
+
Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit after being installed (`pre-commit install`). The continuous integration also runs these checks. Manual options are available so you don't have to commit:
39
40
40
41
```shell
41
42
# run all hooks on all files, mirrors what the CI runs
0 commit comments