pyboomi-cli 0.2.5__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,210 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyboomi-cli
3
+ Version: 0.2.5
4
+ Summary: Command-line interface for Boomi Platform API
5
+ Author-email: Robert Little <robert@iesoftwaredeveloper.com>
6
+ Maintainer-email: Robert Little <robert@iesoftwaredeveloper.com>
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/iesoftwaredeveloper/pyboomi-cli
9
+ Project-URL: Documentation, https://github.com/iesoftwaredeveloper/pyboomi-cli#readme
10
+ Project-URL: Repository, https://github.com/iesoftwaredeveloper/pyboomi-cli.git
11
+ Project-URL: Bug Tracker, https://github.com/iesoftwaredeveloper/pyboomi-cli/issues
12
+ Project-URL: Changelog, https://github.com/iesoftwaredeveloper/pyboomi-cli/blob/main/CHANGELOG.md
13
+ Keywords: boomi,api,cli,integration,platform,etl,middleware
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Environment :: Console
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Intended Audience :: System Administrators
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.8
21
+ Classifier: Programming Language :: Python :: 3.9
22
+ Classifier: Programming Language :: Python :: 3.10
23
+ Classifier: Programming Language :: Python :: 3.11
24
+ Classifier: Programming Language :: Python :: 3.12
25
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
26
+ Classifier: Topic :: System :: Systems Administration
27
+ Classifier: Topic :: Utilities
28
+ Classifier: Typing :: Typed
29
+ Requires-Python: >=3.8
30
+ Description-Content-Type: text/markdown
31
+ License-File: LICENSE
32
+ Requires-Dist: pyboomi_platform>=0.1.0
33
+ Requires-Dist: click>=8.1.0
34
+ Requires-Dist: rich>=13.0.0
35
+ Provides-Extra: dev
36
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
37
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
38
+ Requires-Dist: black>=23.0.0; extra == "dev"
39
+ Requires-Dist: flake8>=6.0.0; extra == "dev"
40
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
41
+ Requires-Dist: isort>=5.12.0; extra == "dev"
42
+ Requires-Dist: pre-commit>=3.0.0; extra == "dev"
43
+ Requires-Dist: tox>=4.0.0; extra == "dev"
44
+ Requires-Dist: build>=0.10.0; extra == "dev"
45
+ Requires-Dist: twine>=4.0.0; extra == "dev"
46
+ Provides-Extra: test
47
+ Requires-Dist: pytest>=7.0.0; extra == "test"
48
+ Requires-Dist: pytest-cov>=4.0.0; extra == "test"
49
+ Provides-Extra: lint
50
+ Requires-Dist: black>=23.0.0; extra == "lint"
51
+ Requires-Dist: flake8>=6.0.0; extra == "lint"
52
+ Requires-Dist: mypy>=1.0.0; extra == "lint"
53
+ Requires-Dist: isort>=5.12.0; extra == "lint"
54
+ Provides-Extra: docs
55
+ Requires-Dist: sphinx>=5.0.0; extra == "docs"
56
+ Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
57
+ Requires-Dist: sphinx-autodoc-typehints>=1.19.0; extra == "docs"
58
+ Dynamic: license-file
59
+
60
+ # pyboomi-cli
61
+
62
+ Command-line interface for the Boomi Platform API.
63
+
64
+ ## Installation
65
+
66
+ ### For Development
67
+
68
+ ```bash
69
+ # Clone the repository
70
+ git clone https://github.com/iesoftwaredeveloper/pyboomi-cli
71
+ cd pyboomi-cli
72
+
73
+ # Install with development dependencies
74
+ pip install -e .[dev]
75
+ ```
76
+
77
+ ### For Usage (when published)
78
+
79
+ ```bash
80
+ pip install pyboomi-cli
81
+ ```
82
+
83
+ ### From Source
84
+
85
+ ```bash
86
+ git clone https://github.com/iesoftwaredeveloper/pyboomi-cli
87
+ cd pyboomi-cli
88
+ pip install -e .
89
+ ```
90
+
91
+ ## Usage
92
+
93
+ ```bash
94
+ # Get help (both entry points are available)
95
+ boomi --help
96
+ pyboomi --help
97
+
98
+ # Query folders (folders alias is supported)
99
+ boomi folder query --account-id YOUR_ACCOUNT_ID --username YOUR_USERNAME --api-token YOUR_API_TOKEN
100
+ # or
101
+ boomi folders query --account-id YOUR_ACCOUNT_ID --username YOUR_USERNAME --api-token YOUR_API_TOKEN
102
+
103
+ # Filter folders by name and print verbose request/response
104
+ boomi folder query --name "My Folder" --verbose
105
+
106
+ # Filter folders with parent constraints
107
+ boomi folder query --name "My Folder" --parent-id 0000-parent-id
108
+ boomi folder query --name "My Folder" --parent-name "Parent Folder"
109
+ boomi folder query --name "My Folder" --parent-path "/Root/Parent"
110
+
111
+ # Create a folder (parent can be provided by id or name/path)
112
+ boomi folder create --name "New Folder" --parent-id 0000-parent-id
113
+ boomi folder create --name "New Folder" --parent-name "Parent Folder"
114
+ boomi folder create --name "New Folder" --parent-name "Parent Folder" --parent-path "/Root/Parent"
115
+
116
+ # Using environment variables
117
+ export BOOMI_ACCT=your-account-id
118
+ export BOOMI_USER=your-username
119
+ export BOOMI_TOKEN=your-api-token
120
+ boomi folder query
121
+
122
+ # Get component XML (optionally include branch/version with ~)
123
+ boomi component get 1234-abcd
124
+ boomi component get 1234-abcd --branch-id 5678-branch --version 1.0
125
+
126
+ # Get component metadata for a branch (json|yaml|text)
127
+ boomi component metadata 1234-abcd --branch-id 5678-branch --output-format json
128
+
129
+ # Create a packaged component
130
+ boomi package create 1234-abcd --version 1.0.0 --notes "Initial package"
131
+
132
+ # Query packaged components by component ID or version (supports xml)
133
+ boomi package query --component-id 1234-abcd --package-version 1.0.0 --output-format xml
134
+
135
+ # Query branches (filter by name or parent)
136
+ boomi branch query --name "feature-x"
137
+
138
+ # Create a new branch under a parent branch
139
+ boomi branch create 1111-parent "feature-x"
140
+
141
+ # Update a branch
142
+ boomi branch update 2222-branch --name "feature-x-renamed" --ready
143
+
144
+ # Delete a branch
145
+ boomi branch delete 2222-branch
146
+ ```
147
+
148
+ ## Commands
149
+
150
+ - `folder` — Manage Boomi folders (group command, alias: `folders`)
151
+ - Subcommands:
152
+ - `folder query` — Query and list folders (`--name`, `--parent-id`, `--parent-name`, `--parent-path`, `--verbose`)
153
+ - `folder create` — Create a folder (`--name` required; `--parent-id` or `--parent-name` required, with optional `--parent-path` to disambiguate; `--output-format` `json|yaml|text`)
154
+ - Common options: `--account-id`, `--username`, `--api-token`
155
+ - `component` — Manage Boomi components (group command)
156
+ - Subcommands:
157
+ - `component get <component_id>` — Get component XML (`--branch-id`, `--version` optional; always returns XML)
158
+ - `component metadata <component_id>` — Get component metadata (`--branch-id` optional; `--output-format` `json|yaml|text`)
159
+ - Common options: `--account-id`, `--username`, `--api-token`
160
+ - `package` — Manage Boomi packages (group command)
161
+ - Subcommands:
162
+ - `package create <component_id> --version <version>` — Create packaged component (`--notes`, `--branch-name`, `--output-format` `json|yaml|text|xml`)
163
+ - `package get <packaged_component_id>` — Get packaged component (`--output-format` `json|yaml|text|xml`)
164
+ - `package query` — Query packaged components (`--component-id`, `--package-version`, `--output-format` `json|yaml|text|xml`)
165
+ - Common options: `--account-id`, `--username`, `--api-token`
166
+ - `branch` — Manage Boomi branches (group command)
167
+ - Subcommands:
168
+ - `branch get <branch_id>` — Get a branch
169
+ - `branch query` — Query branches (`--name`, `--parent-branch-id`, `--package-id`, `--ready`, `--output-format` `json|yaml|text`)
170
+ - `branch create <parent_branch_id> <branch_name>` — Create a branch (`--package-id`, `--output-format` `json|yaml|text`)
171
+ - `branch update <branch_id>` — Update a branch (`--name`, `--description`, `--ready/--not-ready`, `--output-format` `json|yaml|text`)
172
+ - `branch delete <branch_id>` — Delete a branch
173
+ - Common options: `--account-id`, `--username`, `--api-token`
174
+ - `process` — Manage Boomi processes (alias: `processes`) — placeholder
175
+
176
+ ## Environment Variables
177
+
178
+ - `BOOMI_ACCT`: Your Boomi account ID
179
+ - `BOOMI_USER`: Your Boomi username (email)
180
+ - `BOOMI_TOKEN`: Your Boomi API token
181
+ - `BOOMI_AUTH`: Base64 encoded Basic Auth string (alternative to username/token)
182
+
183
+ ## Output Formats
184
+
185
+ Many commands support `--output-format` with the following values:
186
+
187
+ - `json` (default)
188
+ - `yaml` (falls back to json if PyYAML is not installed)
189
+ - `text` (simple key/value text)
190
+ - `xml` (returns raw XML when requested; defaults to XML for `component get`)
191
+
192
+ ## Templates
193
+
194
+ The `templates/` directory contains XML templates for various Boomi component types including:
195
+
196
+ - **Processes**: Unit test harnesses and process templates
197
+ - **Connectors**: Database, API, and file connectors
198
+ - **Profiles**: JSON, XML, flat file, and database profiles
199
+ - **Maps**: Data mapping templates and functions
200
+ - **APIs**: API services and proxy configurations
201
+ - **Scripts**: Process and map scripts
202
+ - **Certificates**: Security certificate templates
203
+
204
+ These templates provide standardized starting points for creating Boomi components. See [TEMPLATE_SYSTEM.md](TEMPLATE_SYSTEM.md) for detailed information about the template system and usage.
205
+
206
+ ## Documentation
207
+
208
+ - [CHANGELOG.md](CHANGELOG.md) - Version history and release notes
209
+ - [TEMPLATE_SYSTEM.md](TEMPLATE_SYSTEM.md) - Template system documentation
210
+ - [TEMPLATES_STRUCTURE.md](TEMPLATES_STRUCTURE.md) - Template directory structure
@@ -0,0 +1,151 @@
1
+ # pyboomi-cli
2
+
3
+ Command-line interface for the Boomi Platform API.
4
+
5
+ ## Installation
6
+
7
+ ### For Development
8
+
9
+ ```bash
10
+ # Clone the repository
11
+ git clone https://github.com/iesoftwaredeveloper/pyboomi-cli
12
+ cd pyboomi-cli
13
+
14
+ # Install with development dependencies
15
+ pip install -e .[dev]
16
+ ```
17
+
18
+ ### For Usage (when published)
19
+
20
+ ```bash
21
+ pip install pyboomi-cli
22
+ ```
23
+
24
+ ### From Source
25
+
26
+ ```bash
27
+ git clone https://github.com/iesoftwaredeveloper/pyboomi-cli
28
+ cd pyboomi-cli
29
+ pip install -e .
30
+ ```
31
+
32
+ ## Usage
33
+
34
+ ```bash
35
+ # Get help (both entry points are available)
36
+ boomi --help
37
+ pyboomi --help
38
+
39
+ # Query folders (folders alias is supported)
40
+ boomi folder query --account-id YOUR_ACCOUNT_ID --username YOUR_USERNAME --api-token YOUR_API_TOKEN
41
+ # or
42
+ boomi folders query --account-id YOUR_ACCOUNT_ID --username YOUR_USERNAME --api-token YOUR_API_TOKEN
43
+
44
+ # Filter folders by name and print verbose request/response
45
+ boomi folder query --name "My Folder" --verbose
46
+
47
+ # Filter folders with parent constraints
48
+ boomi folder query --name "My Folder" --parent-id 0000-parent-id
49
+ boomi folder query --name "My Folder" --parent-name "Parent Folder"
50
+ boomi folder query --name "My Folder" --parent-path "/Root/Parent"
51
+
52
+ # Create a folder (parent can be provided by id or name/path)
53
+ boomi folder create --name "New Folder" --parent-id 0000-parent-id
54
+ boomi folder create --name "New Folder" --parent-name "Parent Folder"
55
+ boomi folder create --name "New Folder" --parent-name "Parent Folder" --parent-path "/Root/Parent"
56
+
57
+ # Using environment variables
58
+ export BOOMI_ACCT=your-account-id
59
+ export BOOMI_USER=your-username
60
+ export BOOMI_TOKEN=your-api-token
61
+ boomi folder query
62
+
63
+ # Get component XML (optionally include branch/version with ~)
64
+ boomi component get 1234-abcd
65
+ boomi component get 1234-abcd --branch-id 5678-branch --version 1.0
66
+
67
+ # Get component metadata for a branch (json|yaml|text)
68
+ boomi component metadata 1234-abcd --branch-id 5678-branch --output-format json
69
+
70
+ # Create a packaged component
71
+ boomi package create 1234-abcd --version 1.0.0 --notes "Initial package"
72
+
73
+ # Query packaged components by component ID or version (supports xml)
74
+ boomi package query --component-id 1234-abcd --package-version 1.0.0 --output-format xml
75
+
76
+ # Query branches (filter by name or parent)
77
+ boomi branch query --name "feature-x"
78
+
79
+ # Create a new branch under a parent branch
80
+ boomi branch create 1111-parent "feature-x"
81
+
82
+ # Update a branch
83
+ boomi branch update 2222-branch --name "feature-x-renamed" --ready
84
+
85
+ # Delete a branch
86
+ boomi branch delete 2222-branch
87
+ ```
88
+
89
+ ## Commands
90
+
91
+ - `folder` — Manage Boomi folders (group command, alias: `folders`)
92
+ - Subcommands:
93
+ - `folder query` — Query and list folders (`--name`, `--parent-id`, `--parent-name`, `--parent-path`, `--verbose`)
94
+ - `folder create` — Create a folder (`--name` required; `--parent-id` or `--parent-name` required, with optional `--parent-path` to disambiguate; `--output-format` `json|yaml|text`)
95
+ - Common options: `--account-id`, `--username`, `--api-token`
96
+ - `component` — Manage Boomi components (group command)
97
+ - Subcommands:
98
+ - `component get <component_id>` — Get component XML (`--branch-id`, `--version` optional; always returns XML)
99
+ - `component metadata <component_id>` — Get component metadata (`--branch-id` optional; `--output-format` `json|yaml|text`)
100
+ - Common options: `--account-id`, `--username`, `--api-token`
101
+ - `package` — Manage Boomi packages (group command)
102
+ - Subcommands:
103
+ - `package create <component_id> --version <version>` — Create packaged component (`--notes`, `--branch-name`, `--output-format` `json|yaml|text|xml`)
104
+ - `package get <packaged_component_id>` — Get packaged component (`--output-format` `json|yaml|text|xml`)
105
+ - `package query` — Query packaged components (`--component-id`, `--package-version`, `--output-format` `json|yaml|text|xml`)
106
+ - Common options: `--account-id`, `--username`, `--api-token`
107
+ - `branch` — Manage Boomi branches (group command)
108
+ - Subcommands:
109
+ - `branch get <branch_id>` — Get a branch
110
+ - `branch query` — Query branches (`--name`, `--parent-branch-id`, `--package-id`, `--ready`, `--output-format` `json|yaml|text`)
111
+ - `branch create <parent_branch_id> <branch_name>` — Create a branch (`--package-id`, `--output-format` `json|yaml|text`)
112
+ - `branch update <branch_id>` — Update a branch (`--name`, `--description`, `--ready/--not-ready`, `--output-format` `json|yaml|text`)
113
+ - `branch delete <branch_id>` — Delete a branch
114
+ - Common options: `--account-id`, `--username`, `--api-token`
115
+ - `process` — Manage Boomi processes (alias: `processes`) — placeholder
116
+
117
+ ## Environment Variables
118
+
119
+ - `BOOMI_ACCT`: Your Boomi account ID
120
+ - `BOOMI_USER`: Your Boomi username (email)
121
+ - `BOOMI_TOKEN`: Your Boomi API token
122
+ - `BOOMI_AUTH`: Base64 encoded Basic Auth string (alternative to username/token)
123
+
124
+ ## Output Formats
125
+
126
+ Many commands support `--output-format` with the following values:
127
+
128
+ - `json` (default)
129
+ - `yaml` (falls back to json if PyYAML is not installed)
130
+ - `text` (simple key/value text)
131
+ - `xml` (returns raw XML when requested; defaults to XML for `component get`)
132
+
133
+ ## Templates
134
+
135
+ The `templates/` directory contains XML templates for various Boomi component types including:
136
+
137
+ - **Processes**: Unit test harnesses and process templates
138
+ - **Connectors**: Database, API, and file connectors
139
+ - **Profiles**: JSON, XML, flat file, and database profiles
140
+ - **Maps**: Data mapping templates and functions
141
+ - **APIs**: API services and proxy configurations
142
+ - **Scripts**: Process and map scripts
143
+ - **Certificates**: Security certificate templates
144
+
145
+ These templates provide standardized starting points for creating Boomi components. See [TEMPLATE_SYSTEM.md](TEMPLATE_SYSTEM.md) for detailed information about the template system and usage.
146
+
147
+ ## Documentation
148
+
149
+ - [CHANGELOG.md](CHANGELOG.md) - Version history and release notes
150
+ - [TEMPLATE_SYSTEM.md](TEMPLATE_SYSTEM.md) - Template system documentation
151
+ - [TEMPLATES_STRUCTURE.md](TEMPLATES_STRUCTURE.md) - Template directory structure
@@ -0,0 +1,55 @@
1
+ # PyBoomi CLI - Main Package
2
+ #
3
+ # Copyright 2025 Robert Little
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ #
17
+ # Development Notes:
18
+ # Contents of this file were produced with the help of code generation tools
19
+ # and subsequently reviewed and edited by the author. While some code was
20
+ # created with AI assistance, manual adjustments have been made to ensure
21
+ # correctness, readability, functionality, and compliance with coding
22
+ # standards. Any future modifications should preserve these manual changes.
23
+ #
24
+ # Author: Robert Little
25
+ # Created: 2025-07-27
26
+
27
+ """
28
+ PyBoomi CLI - Command-line interface for the Boomi Platform API.
29
+
30
+ This package provides a comprehensive command-line tool for interacting with
31
+ the Boomi Platform API. It enables developers and system administrators to
32
+ manage Boomi integrations, processes, folders, and other platform resources
33
+ directly from the terminal.
34
+ """
35
+
36
+ from importlib.metadata import version, PackageNotFoundError
37
+
38
+ try:
39
+ __version__ = version("pyboomi-cli")
40
+ except PackageNotFoundError:
41
+ __version__ = "0.0.0.dev0"
42
+
43
+ __author__ = "Robert Little"
44
+ __copyright__ = "Copyright 2025, Robert Little"
45
+ __license__ = "Apache 2.0"
46
+
47
+ # Import main CLI function for easy access
48
+ from .cli import main
49
+
50
+ __all__ = [
51
+ "__version__",
52
+ "__author__",
53
+ "__license__",
54
+ "main",
55
+ ]