cfn-kickflip 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,9 @@
1
+ AWS CloudFormation Template Flip
2
+ Copyright 2016-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3
+
4
+ ---
5
+ cfn-kickflip
6
+ Copyright 2026 Ben Lampert
7
+ This product is a modified fork of AWS CloudFormation Template Flip
8
+ (https://github.com/awslabs/aws-cfn-template-flip), updates for modern
9
+ Python runtimes and packaging
@@ -0,0 +1,193 @@
1
+ Metadata-Version: 2.4
2
+ Name: cfn-kickflip
3
+ Version: 2.0.0
4
+ Summary: Convert AWS Cloudformation Templates between JSON and YAML formats
5
+ Keywords: aws,cloudformation,cfn,yaml,json,template
6
+ Author: Ben Lampert
7
+ Author-email: Ben Lampert <benjamin.j.lampert@gmail.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ License-File: NOTICE.txt
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: System Administrators
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Programming Language :: Python :: 3.15
21
+ Classifier: Topic :: Software Development :: Code Generators
22
+ Classifier: Topic :: Utilities
23
+ Requires-Dist: click>=8.1
24
+ Requires-Dist: pyyaml>6.0.1
25
+ Requires-Python: >=3.11
26
+ Project-URL: Homepage, https://github.com/bennyandthetuna/cfn-kickflip
27
+ Project-URL: Repository, https://github.com/bennyandthetuna/cfn-kickflip
28
+ Project-URL: Issues, https://github.com/bennyandthetuna/cfn-kickflip/issues
29
+ Project-URL: Upstream, https://github.com/awslabs/aws-cfn-template-flip
30
+ Description-Content-Type: text/markdown
31
+
32
+
33
+ ---
34
+
35
+ [![Build Status](https://github.com/bennyandthetuna/cfn-flip/actions/workflows/test.yml/badge.svg)](https://github.com/bennyandthetuna/cfn-flip/actions/workflows/test.yml)
36
+ [![PyPI version](https://badge.fury.io/py/cfn-flip.svg)](https://badge.fury.io/py/cfn-flip)
37
+ [![Codecov Test Coverage](https://codecov.io/gh/awslabs/aws-cfn-template-flip/branch/master/graphs/badge.svg?style=flat)](https://codecov.io/gh/awslabs/aws-cfn-template-flip)
38
+
39
+ # cfn-kickflip
40
+
41
+ ## About
42
+
43
+ cfn-kickflip is a modified forked version of AWS CloudFormation Template flip. It is intended as a drop-in replacement.
44
+ cfn-kickflip is a tool that converts [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates between [JSON](http://json.org/) and [YAML](http://yaml.org) formats, making use of the YAML format's short function syntax where possible.
45
+
46
+ The term "Flip" is inspired by the well-known Unix command-line tool [flip](https://ccrma.stanford.edu/~craig/utility/flip/) which converts text files between Unix, Mac, and MS-DOS formats.
47
+
48
+ ## Installation
49
+
50
+ cfn-kickflip can be installed using [pip](https://pip.pypa.io/en/stable/):
51
+
52
+ ```bash
53
+ pip install cfn-flip
54
+ ```
55
+
56
+ ## Usage
57
+
58
+ cfn-kickflip is both a command line tool and a python library.
59
+
60
+ Note that the command line tool is spelled `cfn-flip` with a hyphen, while the python package is `cfn_flip` with an underscore.
61
+ From the command line, both `cfn-flip` and `cfn-kickflip` are valid entrypoints to tool execution. As a library, the function
62
+ names are unchanged from AWS Cloudformation Template Flip.
63
+
64
+ ### Command line tool
65
+
66
+ ```
67
+ Usage: cfn-flip [OPTIONS] [INPUT] [OUTPUT]
68
+
69
+ AWS CloudFormation Template Flip is a tool that converts AWS
70
+ CloudFormation templates between JSON and YAML formats, making use of the
71
+ YAML format's short function syntax where possible."
72
+
73
+ Options:
74
+ -i, --input [json|yaml] Specify the input format. Overrides -j and -y
75
+ flags.
76
+ -o, --output [json|yaml] Specify the output format. Overrides -j, -y, and
77
+ -n flags.
78
+ -j, --json Convert to JSON. Assume the input is YAML.
79
+ -y, --yaml Convert to YAML. Assume the input is JSON.
80
+ -c, --clean Performs some opinionated cleanup on your
81
+ template.
82
+ -l, --long Use long-form syntax for functions when converting
83
+ to YAML.
84
+ -n, --no-flip Perform other operations but do not flip the
85
+ output format.
86
+ --version Show the version and exit.
87
+ --help Show this message and exit.
88
+ ```
89
+
90
+
91
+ cfn-flip will detect the format of the input template and convert JSON to YAML and YAML to JSON, respectively.
92
+
93
+ Examples:
94
+
95
+ * Reading from `stdin` and outputting to `stdout`:
96
+
97
+ ```bash
98
+ cat examples/test.json | cfn-flip
99
+ ```
100
+
101
+ * Reading from a file and outputting to `stdout`:
102
+
103
+ ```bash
104
+ cfn-flip examples/test.yaml
105
+ ```
106
+
107
+ * Reading from a file and outputting to another file:
108
+
109
+ ```bash
110
+ cfn-flip examples/test.json output.yaml
111
+ ```
112
+
113
+ * Reading from a file and cleaning up the output
114
+
115
+ ```bash
116
+ cfn-flip -c examples/test.json
117
+ ```
118
+
119
+ ### Python package
120
+
121
+ To use AWS CloudFormation Template Flip from your own python projects, import one of the functions `flip`, `to_yaml`, or `to_json` as needed.
122
+
123
+ ```python
124
+ from cfn_flip import flip, to_yaml, to_json
125
+
126
+ """
127
+ All functions expect a string containing serialised data
128
+ and return a string containing serialised data
129
+ or raise an exception if there is a problem parsing the input
130
+ """
131
+
132
+ # flip takes a best guess at the serialisation format
133
+ # and returns the opposite, converting json into yaml and vice versa
134
+ some_yaml_or_json = flip(some_json_or_yaml)
135
+
136
+ # to_json expects serialised yaml as input, and returns serialised json
137
+ some_json = to_json(some_yaml)
138
+
139
+ # to_yaml expects serialised json as input, and returns serialised yaml
140
+ some_yaml = to_yaml(some_json)
141
+
142
+ # The clean_up flag performs some opinionated, CloudFormation-specific sanitation of the input
143
+ # For example, converting uses of Fn::Join to Fn::Sub
144
+ # flip, to_yaml, and to_json all support the clean_up flag
145
+ clean_yaml = to_yaml(some_json, clean_up=True)
146
+ ```
147
+
148
+ ### Configuration paramters
149
+
150
+ You can configure some parameters like:
151
+
152
+ `max_col_width`: Maximum columns before breakline. Default value is 200
153
+ To change the configuration you can use:
154
+
155
+ **Environment Variable**
156
+
157
+ Linux/Unix:
158
+ `export CFN_MAX_COL_WIDTH=120`
159
+
160
+ Windows: `SET CFN_MAX_COL_WIDTH=120`
161
+
162
+ **Python**
163
+
164
+ ```python
165
+
166
+ from cfn_tools._config import config
167
+ from cfn_flip import flip, to_yaml, to_json
168
+
169
+ """
170
+ All functions expect a string containing serialised data
171
+ and return a string containing serialised data
172
+ or raise an exception if there is a problem parsing the input
173
+ """
174
+
175
+ # Change the default number of columns to break line to 120
176
+ config['max_col_width'] = "120"
177
+
178
+ # flip takes a best guess at the serialisation format
179
+ # and returns the opposite, converting json into yaml and vice versa
180
+ some_yaml_or_json = flip(some_json_or_yaml)
181
+
182
+ # to_json expects serialised yaml as input, and returns serialised json
183
+ some_json = to_json(some_yaml)
184
+
185
+ # to_yaml expects serialised json as input, and returns serialised yaml
186
+ some_yaml = to_yaml(some_json)
187
+
188
+ # The clean_up flag performs some opinionated, CloudFormation-specific sanitation of the input
189
+ # For example, converting uses of Fn::Join to Fn::Sub
190
+ # flip, to_yaml, and to_json all support the clean_up flag
191
+ clean_yaml = to_yaml(some_json, clean_up=True)
192
+
193
+ ```
@@ -0,0 +1,162 @@
1
+
2
+ ---
3
+
4
+ [![Build Status](https://github.com/bennyandthetuna/cfn-flip/actions/workflows/test.yml/badge.svg)](https://github.com/bennyandthetuna/cfn-flip/actions/workflows/test.yml)
5
+ [![PyPI version](https://badge.fury.io/py/cfn-flip.svg)](https://badge.fury.io/py/cfn-flip)
6
+ [![Codecov Test Coverage](https://codecov.io/gh/awslabs/aws-cfn-template-flip/branch/master/graphs/badge.svg?style=flat)](https://codecov.io/gh/awslabs/aws-cfn-template-flip)
7
+
8
+ # cfn-kickflip
9
+
10
+ ## About
11
+
12
+ cfn-kickflip is a modified forked version of AWS CloudFormation Template flip. It is intended as a drop-in replacement.
13
+ cfn-kickflip is a tool that converts [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates between [JSON](http://json.org/) and [YAML](http://yaml.org) formats, making use of the YAML format's short function syntax where possible.
14
+
15
+ The term "Flip" is inspired by the well-known Unix command-line tool [flip](https://ccrma.stanford.edu/~craig/utility/flip/) which converts text files between Unix, Mac, and MS-DOS formats.
16
+
17
+ ## Installation
18
+
19
+ cfn-kickflip can be installed using [pip](https://pip.pypa.io/en/stable/):
20
+
21
+ ```bash
22
+ pip install cfn-flip
23
+ ```
24
+
25
+ ## Usage
26
+
27
+ cfn-kickflip is both a command line tool and a python library.
28
+
29
+ Note that the command line tool is spelled `cfn-flip` with a hyphen, while the python package is `cfn_flip` with an underscore.
30
+ From the command line, both `cfn-flip` and `cfn-kickflip` are valid entrypoints to tool execution. As a library, the function
31
+ names are unchanged from AWS Cloudformation Template Flip.
32
+
33
+ ### Command line tool
34
+
35
+ ```
36
+ Usage: cfn-flip [OPTIONS] [INPUT] [OUTPUT]
37
+
38
+ AWS CloudFormation Template Flip is a tool that converts AWS
39
+ CloudFormation templates between JSON and YAML formats, making use of the
40
+ YAML format's short function syntax where possible."
41
+
42
+ Options:
43
+ -i, --input [json|yaml] Specify the input format. Overrides -j and -y
44
+ flags.
45
+ -o, --output [json|yaml] Specify the output format. Overrides -j, -y, and
46
+ -n flags.
47
+ -j, --json Convert to JSON. Assume the input is YAML.
48
+ -y, --yaml Convert to YAML. Assume the input is JSON.
49
+ -c, --clean Performs some opinionated cleanup on your
50
+ template.
51
+ -l, --long Use long-form syntax for functions when converting
52
+ to YAML.
53
+ -n, --no-flip Perform other operations but do not flip the
54
+ output format.
55
+ --version Show the version and exit.
56
+ --help Show this message and exit.
57
+ ```
58
+
59
+
60
+ cfn-flip will detect the format of the input template and convert JSON to YAML and YAML to JSON, respectively.
61
+
62
+ Examples:
63
+
64
+ * Reading from `stdin` and outputting to `stdout`:
65
+
66
+ ```bash
67
+ cat examples/test.json | cfn-flip
68
+ ```
69
+
70
+ * Reading from a file and outputting to `stdout`:
71
+
72
+ ```bash
73
+ cfn-flip examples/test.yaml
74
+ ```
75
+
76
+ * Reading from a file and outputting to another file:
77
+
78
+ ```bash
79
+ cfn-flip examples/test.json output.yaml
80
+ ```
81
+
82
+ * Reading from a file and cleaning up the output
83
+
84
+ ```bash
85
+ cfn-flip -c examples/test.json
86
+ ```
87
+
88
+ ### Python package
89
+
90
+ To use AWS CloudFormation Template Flip from your own python projects, import one of the functions `flip`, `to_yaml`, or `to_json` as needed.
91
+
92
+ ```python
93
+ from cfn_flip import flip, to_yaml, to_json
94
+
95
+ """
96
+ All functions expect a string containing serialised data
97
+ and return a string containing serialised data
98
+ or raise an exception if there is a problem parsing the input
99
+ """
100
+
101
+ # flip takes a best guess at the serialisation format
102
+ # and returns the opposite, converting json into yaml and vice versa
103
+ some_yaml_or_json = flip(some_json_or_yaml)
104
+
105
+ # to_json expects serialised yaml as input, and returns serialised json
106
+ some_json = to_json(some_yaml)
107
+
108
+ # to_yaml expects serialised json as input, and returns serialised yaml
109
+ some_yaml = to_yaml(some_json)
110
+
111
+ # The clean_up flag performs some opinionated, CloudFormation-specific sanitation of the input
112
+ # For example, converting uses of Fn::Join to Fn::Sub
113
+ # flip, to_yaml, and to_json all support the clean_up flag
114
+ clean_yaml = to_yaml(some_json, clean_up=True)
115
+ ```
116
+
117
+ ### Configuration paramters
118
+
119
+ You can configure some parameters like:
120
+
121
+ `max_col_width`: Maximum columns before breakline. Default value is 200
122
+ To change the configuration you can use:
123
+
124
+ **Environment Variable**
125
+
126
+ Linux/Unix:
127
+ `export CFN_MAX_COL_WIDTH=120`
128
+
129
+ Windows: `SET CFN_MAX_COL_WIDTH=120`
130
+
131
+ **Python**
132
+
133
+ ```python
134
+
135
+ from cfn_tools._config import config
136
+ from cfn_flip import flip, to_yaml, to_json
137
+
138
+ """
139
+ All functions expect a string containing serialised data
140
+ and return a string containing serialised data
141
+ or raise an exception if there is a problem parsing the input
142
+ """
143
+
144
+ # Change the default number of columns to break line to 120
145
+ config['max_col_width'] = "120"
146
+
147
+ # flip takes a best guess at the serialisation format
148
+ # and returns the opposite, converting json into yaml and vice versa
149
+ some_yaml_or_json = flip(some_json_or_yaml)
150
+
151
+ # to_json expects serialised yaml as input, and returns serialised json
152
+ some_json = to_json(some_yaml)
153
+
154
+ # to_yaml expects serialised json as input, and returns serialised yaml
155
+ some_yaml = to_yaml(some_json)
156
+
157
+ # The clean_up flag performs some opinionated, CloudFormation-specific sanitation of the input
158
+ # For example, converting uses of Fn::Join to Fn::Sub
159
+ # flip, to_yaml, and to_json all support the clean_up flag
160
+ clean_yaml = to_yaml(some_json, clean_up=True)
161
+
162
+ ```