sudoo-cli 3.0.0__py3-none-any.whl

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.
sudoo_cli/signing.py ADDED
@@ -0,0 +1,65 @@
1
+ """Request signing, exactly as the panel's API describes it (docs/PANEL_API.md, section 2).
2
+
3
+ The signed text is five lines joined with "\\n" (no newline at the end), six with X-Sudoo-Acting-For:
4
+
5
+ <timestamp>
6
+ <nonce>
7
+ <METHOD>
8
+ <path, with ?query>
9
+ <hex SHA-256 of the exact body bytes; of an empty body when there is none>
10
+ <X-Sudoo-Acting-For, only when sent>
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ import hashlib
16
+ import hmac
17
+ import re
18
+ import secrets
19
+ import time
20
+
21
+ ACTING_FOR = re.compile(r"[A-Za-z0-9._@+\-]{1,120}")
22
+
23
+
24
+ def new_nonce() -> str:
25
+ """32 random letters, digits, '-' or '_' (the panel accepts 16 to 64)."""
26
+ return secrets.token_urlsafe(24)
27
+
28
+
29
+ def signed_text(
30
+ timestamp: str, nonce: str, method: str, path: str, body: bytes, acting_for: str | None = None
31
+ ) -> bytes:
32
+ lines = [timestamp, nonce, method.upper(), path, hashlib.sha256(body).hexdigest()]
33
+ if acting_for is not None:
34
+ lines.append(acting_for)
35
+ return "\n".join(lines).encode()
36
+
37
+
38
+ def signature(secret: str, text: bytes) -> str:
39
+ return "sha256=" + hmac.new(secret.encode(), text, hashlib.sha256).hexdigest()
40
+
41
+
42
+ def sign(
43
+ token: str,
44
+ secret: str,
45
+ method: str,
46
+ path: str,
47
+ body: bytes = b"",
48
+ acting_for: str | None = None,
49
+ now: float | None = None,
50
+ nonce: str | None = None,
51
+ ) -> dict[str, str]:
52
+ """The authentication headers of one request. `path` starts with /api/v1 and includes the query string."""
53
+ if acting_for is not None and not ACTING_FOR.fullmatch(acting_for):
54
+ raise ValueError("acting-for: 1 to 120 letters, digits, '.', '_', '@', '+' or '-'")
55
+ timestamp = str(int(time.time() if now is None else now))
56
+ nonce = nonce or new_nonce()
57
+ headers = {
58
+ "Authorization": f"Bearer {token}",
59
+ "X-Sudoo-Timestamp": timestamp,
60
+ "X-Sudoo-Nonce": nonce,
61
+ "X-Sudoo-Signature": signature(secret, signed_text(timestamp, nonce, method, path, body, acting_for)),
62
+ }
63
+ if acting_for is not None:
64
+ headers["X-Sudoo-Acting-For"] = acting_for
65
+ return headers
@@ -0,0 +1,116 @@
1
+ Metadata-Version: 2.4
2
+ Name: sudoo-cli
3
+ Version: 3.0.0
4
+ Summary: The sudoo command: manage the projects, instances, backups, domains and jobs of a Sudoo.sh panel from a terminal or a CI pipeline.
5
+ Keywords: sudoo,odoo,cli,devops,ci
6
+ Author: Sudoo.sh
7
+ Author-email: Sudoo.sh <support@sudoo.sh>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE.md
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: System Administrators
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: System :: Systems Administration
20
+ Classifier: Typing :: Typed
21
+ Requires-Dist: keyring>=25.6.0 ; extra == 'keyring'
22
+ Requires-Python: >=3.12
23
+ Project-URL: Homepage, https://sudoo.sh
24
+ Project-URL: Documentation, https://docs.sudoo.sh/cli
25
+ Project-URL: Source, https://github.com/Sudoo-sh/sudoo-cli
26
+ Project-URL: Issues, https://github.com/Sudoo-sh/sudoo-cli/issues
27
+ Project-URL: Changelog, https://github.com/Sudoo-sh/sudoo-cli/blob/main/CHANGELOG.md
28
+ Provides-Extra: keyring
29
+ Description-Content-Type: text/markdown
30
+
31
+ # sudoo-cli
32
+
33
+ `sudoo` is the command-line client of the [Sudoo.sh](https://sudoo.sh) panel: list and create instances, deploy
34
+ the latest code of a branch, follow jobs live, back up and restore, manage custom domains and read caught mail, from
35
+ a terminal or a CI pipeline. Every request is signed with your API token's signing secret, exactly as the panel's
36
+ API requires.
37
+
38
+ It needs Python 3.12 or later and nothing else (the OS keyring is optional).
39
+
40
+ ## Install
41
+
42
+ ```bash
43
+ pipx install sudoo-cli # or: uv tool install sudoo-cli
44
+ pipx install 'sudoo-cli[keyring]' # keep credentials in the OS keyring
45
+ ```
46
+
47
+ On a server without pip, download `sudoo.pyz` (one file) from the
48
+ [latest release](https://github.com/Sudoo-sh/sudoo-cli/releases/latest), check it against `SHA256SUMS`, and run
49
+ `python3 sudoo.pyz`.
50
+
51
+ ## Log in
52
+
53
+ Create an API token in the panel (**API tokens**, **Create token**), then:
54
+
55
+ ```bash
56
+ sudoo login --url https://panel.example.com # asks for the token and the signing secret
57
+ sudoo status
58
+ ```
59
+
60
+ The credentials go to the OS keyring when available, else to `~/.config/sudoo/credentials.json` (mode 0600). Use
61
+ `--profile NAME` for several panels. In CI, set `SUDOO_URL`, `SUDOO_TOKEN` and `SUDOO_SECRET` instead: no login and
62
+ no file are needed.
63
+
64
+ ## Examples
65
+
66
+ ```bash
67
+ sudoo instances list
68
+ sudoo instances create --repo https://github.com/acme/sales --branch feature-x --odoo-version 19.0 --delete-after-days 7
69
+ sudoo deploy --project sales --branch main # get the latest code and follow the job
70
+ sudoo instances logs sales-main --follow
71
+ sudoo backups create sales-main
72
+ sudoo backups download sales-main__sales_main__20261112-000012__daily.zip
73
+ sudoo domains add sales-main erp.acme.com --confirm-production
74
+ sudoo jobs follow a12fff66a05d
75
+ sudoo instances show sales-main --json | jq -r .data.url
76
+ ```
77
+
78
+ `--json` prints machine-readable output; exit codes are documented (11 when a followed job fails, 8 when still
79
+ rate-limited, ...).
80
+
81
+ ### GitHub Actions deploy step
82
+
83
+ ```yaml
84
+ - name: Deploy to the panel
85
+ env:
86
+ SUDOO_URL: ${{ vars.SUDOO_URL }}
87
+ SUDOO_TOKEN: ${{ secrets.SUDOO_TOKEN }}
88
+ SUDOO_SECRET: ${{ secrets.SUDOO_SECRET }}
89
+ run: |
90
+ pipx install sudoo-cli==3.0.0
91
+ sudoo deploy --project sales --branch "${GITHUB_REF_NAME}"
92
+ ```
93
+
94
+ Deploying needs a token with the `write` scope; give each pipeline its own token.
95
+
96
+ ## Documentation
97
+
98
+ Every command, option, exit code and more CI examples: [docs/CLI.md](docs/CLI.md), also on
99
+ [docs.sudoo.sh/cli](https://docs.sudoo.sh/cli).
100
+
101
+ ## Development
102
+
103
+ ```bash
104
+ uv sync
105
+ uv run pytest # against a local mock panel; never a real one
106
+ uv run ruff check . && uv run ruff format --check . && uv run mypy
107
+ uv run python scripts/build_zipapp.py && ./dist/sudoo.pyz version
108
+ ```
109
+
110
+ Releases: bump the version in `pyproject.toml` and `src/sudoo_cli/__init__.py`, add the changes to `CHANGELOG.md`,
111
+ tag `vX.Y.Z` and push the tag; the publish workflow tests, builds, publishes to PyPI (Trusted Publishing) and
112
+ creates the GitHub release with `sudoo.pyz`.
113
+
114
+ ## Licence
115
+
116
+ [Apache License 2.0](LICENSE.md). "Sudoo" and "Sudoo.sh" are trademarks of the copyright holder.
@@ -0,0 +1,17 @@
1
+ sudoo_cli/__init__.py,sha256=au-5dnWH59_NlQeev2qe_NSZ_Ykt0UGklSLEiscrBrM,83
2
+ sudoo_cli/__main__.py,sha256=mTgYJjZVkEXi-Nkmb6dymlEAa2EXEeLCqpNGq1khj_0,169
3
+ sudoo_cli/cli.py,sha256=Ed2WWci-MwpVPoHzL8kNCVvBCOXaXw1TdfWD-LPEFC4,17144
4
+ sudoo_cli/client.py,sha256=xhO8PGK3TVQ6K7_JznId5ZSfYjstHtIHz1zRtc5u22I,13446
5
+ sudoo_cli/commands.py,sha256=xOo4ZSLIomBp2HO7UcWVrQKiwt99qE_cQBCiBHTpeXY,32823
6
+ sudoo_cli/completion.py,sha256=p9EAZpkNnalhTZhkoB4dTwF6nuqMyqWRAs8sYM4NzCQ,3862
7
+ sudoo_cli/config.py,sha256=xmhWtIKap_nswmoPuQ0dPfljKjAmoFEMWAlYxJl8aWc,8216
8
+ sudoo_cli/context.py,sha256=eOKwfzD_97S9tsBZH7JlLTNdiURa6JEOReNqhxEIxzc,2911
9
+ sudoo_cli/errors.py,sha256=KepKq_0iNiUVRnTg8xDsh_egpTBdgXD7bf91DT9oJ_o,2541
10
+ sudoo_cli/jobs.py,sha256=Jzm0f_xIwhjdCPVWNba2n7V5xm_fjv84Uf-PLFL5cKE,4380
11
+ sudoo_cli/output.py,sha256=BJcZxX36t8ikfkvxkpgplPS0YMZ6IMGeosYk_2TrJFw,2899
12
+ sudoo_cli/signing.py,sha256=Wlyp9f_Ad4j3rv3wnDJOAFK3qFShghoVIarHjaBEXko,2068
13
+ sudoo_cli-3.0.0.dist-info/licenses/LICENSE.md,sha256=xBVk3TClQ97eA04sBt2tYid0pysBuVLfSPdjPJm7R5k,11620
14
+ sudoo_cli-3.0.0.dist-info/WHEEL,sha256=G_-rrEibZr7OEM7zdH1dSO6s-VdjfnS5PA4CLAdI9Vw,80
15
+ sudoo_cli-3.0.0.dist-info/entry_points.txt,sha256=h_cg3sBNK_ZFw8NP9TQl6ZO-HJvhHLCL2NGDfIsgk0o,46
16
+ sudoo_cli-3.0.0.dist-info/METADATA,sha256=fm08MU7HqcyjipmwZ-LXHOhU2u6J9v52zOUSMQ-sjpE,4437
17
+ sudoo_cli-3.0.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: uv 0.13.9
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,3 @@
1
+ [console_scripts]
2
+ sudoo = sudoo_cli.cli:main
3
+
@@ -0,0 +1,209 @@
1
+ Copyright 2026 Yousef M. Y. Al Sabbah
2
+
3
+ Licensed under the Apache License, Version 2.0 (the full text follows). "Sudoo" and "Sudoo.sh" and their logo are
4
+ trademarks of the copyright holder; section 6 of the licence does not grant permission to use them.
5
+
6
+ ```
7
+
8
+ Apache License
9
+ Version 2.0, January 2004
10
+ http://www.apache.org/licenses/
11
+
12
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+ 1. Definitions.
15
+
16
+ "License" shall mean the terms and conditions for use, reproduction,
17
+ and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+ "Licensor" shall mean the copyright owner or entity authorized by
20
+ the copyright owner that is granting the License.
21
+
22
+ "Legal Entity" shall mean the union of the acting entity and all
23
+ other entities that control, are controlled by, or are under common
24
+ control with that entity. For the purposes of this definition,
25
+ "control" means (i) the power, direct or indirect, to cause the
26
+ direction or management of such entity, whether by contract or
27
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+ "You" (or "Your") shall mean an individual or Legal Entity
31
+ exercising permissions granted by this License.
32
+
33
+ "Source" form shall mean the preferred form for making modifications,
34
+ including but not limited to software source code, documentation
35
+ source, and configuration files.
36
+
37
+ "Object" form shall mean any form resulting from mechanical
38
+ transformation or translation of a Source form, including but
39
+ not limited to compiled object code, generated documentation,
40
+ and conversions to other media types.
41
+
42
+ "Work" shall mean the work of authorship, whether in Source or
43
+ Object form, made available under the License, as indicated by a
44
+ copyright notice that is included in or attached to the work
45
+ (an example is provided in the Appendix below).
46
+
47
+ "Derivative Works" shall mean any work, whether in Source or Object
48
+ form, that is based on (or derived from) the Work and for which the
49
+ editorial revisions, annotations, elaborations, or other modifications
50
+ represent, as a whole, an original work of authorship. For the purposes
51
+ of this License, Derivative Works shall not include works that remain
52
+ separable from, or merely link (or bind by name) to the interfaces of,
53
+ the Work and Derivative Works thereof.
54
+
55
+ "Contribution" shall mean any work of authorship, including
56
+ the original version of the Work and any modifications or additions
57
+ to that Work or Derivative Works thereof, that is intentionally
58
+ submitted to Licensor for inclusion in the Work by the copyright owner
59
+ or by an individual or Legal Entity authorized to submit on behalf of
60
+ the copyright owner. For the purposes of this definition, "submitted"
61
+ means any form of electronic, verbal, or written communication sent
62
+ to the Licensor or its representatives, including but not limited to
63
+ communication on electronic mailing lists, source code control systems,
64
+ and issue tracking systems that are managed by, or on behalf of, the
65
+ Licensor for the purpose of discussing and improving the Work, but
66
+ excluding communication that is conspicuously marked or otherwise
67
+ designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+ "Contributor" shall mean Licensor and any individual or Legal Entity
70
+ on behalf of whom a Contribution has been received by Licensor and
71
+ subsequently incorporated within the Work.
72
+
73
+ 2. Grant of Copyright 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
+ copyright license to reproduce, prepare Derivative Works of,
77
+ publicly display, publicly perform, sublicense, and distribute the
78
+ Work and such Derivative Works in Source or Object form.
79
+
80
+ 3. Grant of Patent License. Subject to the terms and conditions of
81
+ this License, each Contributor hereby grants to You a perpetual,
82
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+ (except as stated in this section) patent license to make, have made,
84
+ use, offer to sell, sell, import, and otherwise transfer the Work,
85
+ where such license applies only to those patent claims licensable
86
+ by such Contributor that are necessarily infringed by their
87
+ Contribution(s) alone or by combination of their Contribution(s)
88
+ with the Work to which such Contribution(s) was submitted. If You
89
+ institute patent litigation against any entity (including a
90
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+ or a Contribution incorporated within the Work constitutes direct
92
+ or contributory patent infringement, then any patent licenses
93
+ granted to You under this License for that Work shall terminate
94
+ as of the date such litigation is filed.
95
+
96
+ 4. Redistribution. You may reproduce and distribute copies of the
97
+ Work or Derivative Works thereof in any medium, with or without
98
+ modifications, and in Source or Object form, provided that You
99
+ meet the following conditions:
100
+
101
+ (a) You must give any other recipients of the Work or
102
+ Derivative Works a copy of this License; and
103
+
104
+ (b) You must cause any modified files to carry prominent notices
105
+ stating that You changed the files; and
106
+
107
+ (c) You must retain, in the Source form of any Derivative Works
108
+ that You distribute, all copyright, patent, trademark, and
109
+ attribution notices from the Source form of the Work,
110
+ excluding those notices that do not pertain to any part of
111
+ the Derivative Works; and
112
+
113
+ (d) If the Work includes a "NOTICE" text file as part of its
114
+ distribution, then any Derivative Works that You distribute must
115
+ include a readable copy of the attribution notices contained
116
+ within such NOTICE file, excluding those notices that do not
117
+ pertain to any part of the Derivative Works, in at least one
118
+ of the following places: within a NOTICE text file distributed
119
+ as part of the Derivative Works; within the Source form or
120
+ documentation, if provided along with the Derivative Works; or,
121
+ within a display generated by the Derivative Works, if and
122
+ wherever such third-party notices normally appear. The contents
123
+ of the NOTICE file are for informational purposes only and
124
+ do not modify the License. You may add Your own attribution
125
+ notices within Derivative Works that You distribute, alongside
126
+ or as an addendum to the NOTICE text from the Work, provided
127
+ that such additional attribution notices cannot be construed
128
+ as modifying the License.
129
+
130
+ You may add Your own copyright statement to Your modifications and
131
+ may provide additional or different license terms and conditions
132
+ for use, reproduction, or distribution of Your modifications, or
133
+ for any such Derivative Works as a whole, provided Your use,
134
+ reproduction, and distribution of the Work otherwise complies with
135
+ the conditions stated in this License.
136
+
137
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
138
+ any Contribution intentionally submitted for inclusion in the Work
139
+ by You to the Licensor shall be under the terms and conditions of
140
+ this License, without any additional terms or conditions.
141
+ Notwithstanding the above, nothing herein shall supersede or modify
142
+ the terms of any separate license agreement you may have executed
143
+ with Licensor regarding such Contributions.
144
+
145
+ 6. Trademarks. This License does not grant permission to use the trade
146
+ names, trademarks, service marks, or product names of the Licensor,
147
+ except as required for reasonable and customary use in describing the
148
+ origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+ 7. Disclaimer of Warranty. Unless required by applicable law or
151
+ agreed to in writing, Licensor provides the Work (and each
152
+ Contributor provides its Contributions) on an "AS IS" BASIS,
153
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+ implied, including, without limitation, any warranties or conditions
155
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+ PARTICULAR PURPOSE. You are solely responsible for determining the
157
+ appropriateness of using or redistributing the Work and assume any
158
+ risks associated with Your exercise of permissions under this License.
159
+
160
+ 8. Limitation of Liability. In no event and under no legal theory,
161
+ whether in tort (including negligence), contract, or otherwise,
162
+ unless required by applicable law (such as deliberate and grossly
163
+ negligent acts) or agreed to in writing, shall any Contributor be
164
+ liable to You for damages, including any direct, indirect, special,
165
+ incidental, or consequential damages of any character arising as a
166
+ result of this License or out of the use or inability to use the
167
+ Work (including but not limited to damages for loss of goodwill,
168
+ work stoppage, computer failure or malfunction, or any and all
169
+ other commercial damages or losses), even if such Contributor
170
+ has been advised of the possibility of such damages.
171
+
172
+ 9. Accepting Warranty or Additional Liability. While redistributing
173
+ the Work or Derivative Works thereof, You may choose to offer,
174
+ and charge a fee for, acceptance of support, warranty, indemnity,
175
+ or other liability obligations and/or rights consistent with this
176
+ License. However, in accepting such obligations, You may act only
177
+ on Your own behalf and on Your sole responsibility, not on behalf
178
+ of any other Contributor, and only if You agree to indemnify,
179
+ defend, and hold each Contributor harmless for any liability
180
+ incurred by, or claims asserted against, such Contributor by reason
181
+ of your accepting any such warranty or additional liability.
182
+
183
+ END OF TERMS AND CONDITIONS
184
+
185
+ APPENDIX: How to apply the Apache License to your work.
186
+
187
+ To apply the Apache License to your work, attach the following
188
+ boilerplate notice, with the fields enclosed by brackets "[]"
189
+ replaced with your own identifying information. (Don't include
190
+ the brackets!) The text should be enclosed in the appropriate
191
+ comment syntax for the file format. We also recommend that a
192
+ file or class name and description of purpose be included on the
193
+ same "printed page" as the copyright notice for easier
194
+ identification within third-party archives.
195
+
196
+ Copyright [yyyy] [name of copyright owner]
197
+
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+ ```