tbctl 0.2.0__tar.gz

tbctl-0.2.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+dist/
+.coverage
+htmlcov/
+# Generated OpenAPI client, built by ./generate.sh.
+generated/

tbctl-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tbctl-0.2.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: tbctl
+Version: 0.2.0
+Summary: CLI for ThingsBoard OTA package management
+Project-URL: Homepage, https://github.com/mbrunnen/tbctl
+Project-URL: Repository, https://github.com/mbrunnen/tbctl
+Project-URL: Issues, https://github.com/mbrunnen/tbctl/issues
+Author: Manoel Brunnen
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cli,iot,ota,thingsboard
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.11
+Requires-Dist: plotext>=5
+Requires-Dist: pydantic>=2
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: rich>=13
+Requires-Dist: tomli-w>=1.0
+Requires-Dist: typer>=0.12
+Requires-Dist: urllib3>=2
+Description-Content-Type: text/markdown
+
+# tbctl
+
+CLI for ThingsBoard OTA package management.
+
+## Installation
+
+```sh
+uv tool install tbctl
+tbctl --install-completion
+exec zsh
+```
+
+Alternatively with pipx:
+
+```sh
+pipx install tbctl
+```
+
+### Testing pre-releases
+
+Release candidates are published to TestPyPI. Install one with the extra index
+so uv can resolve the runtime dependencies from PyPI:
+
+```sh
+uv tool install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  tbctl
+```
+
+### From a local checkout
+
+To install the working tree instead of the published package, point `uv tool
+install` at the path (a bare `uv tool install tbctl` fails because the package
+is not on the public registry):
+
+```sh
+./generate.sh            # build the generated client (gitignored, bundled into the wheel)
+uv tool install .        # install the current checkout as a uv tool
+tbctl --install-completion
+exec zsh
+```
+
+## Update
+
+```sh
+uv tool upgrade tbctl
+tbctl --install-completion
+exec zsh
+```
+
+For a local checkout, `uv tool upgrade` does not apply; reinstall instead.
+Because the version does not change between builds, `--refresh` is needed to
+bypass the cached wheel:
+
+```sh
+uv tool install . --reinstall --refresh
+```
+
+## Configuration
+
+The quickest way to get started is the interactive wizard, which prompts for the
+URL and token and verifies them against the server before saving:
+
+```sh
+tbctl config init
+```
+
+The individual commands are also available:
+
+```sh
+tbctl config set-url https://thingsboard.example.com
+tbctl config set-token <api-token>
+tbctl config show
+```
+
+Multiple config profiles are supported via `--config <name>` / `-c` (default: `default`).
+
+## Usage
+
+```sh
+tbctl ota list
+tbctl ota list --search firmware --type FIRMWARE --sort-by createdTime --sort-order DESC
+tbctl ota list --version 1.4.0                             # filter by version (client-side)
+tbctl ota list --search app-fw --version 1.4.0             # narrow by title, then version
+tbctl ota list --device-profile <uuid> --type FIRMWARE
+tbctl ota list --json
+
+tbctl ota get <uuid>
+tbctl ota delete <uuid>
+
+tbctl ota upload firmware.bin --title app-fw --version 1.4.0 --device-profile sensor-v2
+tbctl ota upload firmware.bin --title app-sw --version 1.4.0 --type SOFTWARE --device-profile sensor-v2
+tbctl ota upload --url http://host/fw.bin --title app-fw --version 1.4.0 --device-profile sensor-v2
+
+tbctl ota download <uuid>                                   # by package id
+tbctl ota download --device-profile sensor-v2               # profile's assigned firmware
+tbctl ota download --device-profile sensor-v2 --version 1.4.0
+tbctl ota download --device thermostat-01                   # device's firmware (falls back to its profile)
+tbctl ota download --device thermostat-01 --version 1.4.0
+tbctl ota download --name app-fw --latest                   # newest package with this title
+tbctl ota download --name app-fw --version 1.4.0 --type SOFTWARE
+tbctl ota download --name app-fw -o ./out.bin --force       # custom path, overwrite if present
+
+tbctl ota assign app-fw thermostat-01                       # assign latest by title, to a device
+tbctl ota assign app-fw thermostat-01 --version 1.4.0 --type SOFTWARE
+tbctl ota assign <package-uuid> <device-uuid>
+tbctl ota unassign thermostat-01                            # clear the device's FIRMWARE assignment
+tbctl ota unassign thermostat-01 --type SOFTWARE
+
+tbctl device list
+tbctl device list --search sensor --type default --sort-by createdTime --sort-order DESC
+tbctl device list --customer <customer-uuid> --token   # devices of a customer, with access tokens
+tbctl device list --json
+tbctl device get <device>
+tbctl device create sensor-1 --profile default --label Lobby
+tbctl device update sensor-1 --label "Main hall" --profile thermostat
+tbctl device delete sensor-1 --yes
+tbctl device assign sensor-1 --customer <customer-uuid>
+
+tbctl telemetry keys <device>
+tbctl telemetry latest <device> --keys temperature,humidity
+tbctl telemetry history <device> --keys temperature --last 24h
+tbctl telemetry history <device> --keys temperature --start 2026-06-01 --end 2026-06-25
+tbctl telemetry history <device> --keys temperature --last 7d --plot
+
+tbctl attributes get <device>
+tbctl attributes get <device> --scope SERVER_SCOPE --keys fwVersion
+```
+
+`<device>` accepts a device UUID or a device name. Name resolution needs an API
+token with tenant device-read permission; otherwise pass the UUID directly.
+
+`tbctl ota upload` creates a package from exactly one source: a local file
+argument or `--url` for an externally hosted package. `--title`, `--version`,
+and `--device-profile` (name or UUID) are required; `--type` defaults to
+`FIRMWARE`. For file uploads the checksum is computed locally
+(`--checksum-algorithm`, default `SHA256`) and sent alongside the data.
+
+`tbctl ota list --search` maps to ThingsBoard's server-side text search, which
+matches the package title only. Use `--version` for a client-side,
+case-insensitive substring filter on the version; when given, all pages are
+fetched and filtered locally, and it combines with `--search`.
+
+`tbctl ota download` takes exactly one selector (a package id, `--device-profile`,
+`--device`, or `--name`). For a profile or device, the assigned package is used
+unless `--version` is given; for `--name`, the newest version is used unless
+`--version` is given. `--type` defaults to `FIRMWARE` (`--type SOFTWARE` for
+software). Without `-o/--output` the file is saved under the package's own file
+name in the current directory, and an existing file is only overwritten with
+`--force`.
+
+`tbctl ota assign` takes a package id or title and a device. `--type` defaults
+to `FIRMWARE`; with a title, the newest version is used unless `--version` is
+given. `tbctl ota unassign` clears the device's `--type` assignment (default
+`FIRMWARE`).
+
+## Development
+
+```sh
+./generate.sh   # build the client first, so the editable install can see it
+uv sync
+uv run tbctl
+uv run pytest
+pre-commit run --all-files
+```
+
+The editable install only sees `tb_client` if it exists at install time. After
+regenerating the client, refresh the editable path:
+
+```sh
+uv pip install -e . --force-reinstall
+```

tbctl-0.2.0/README.md

@@ -0,0 +1,173 @@
+# tbctl
+
+CLI for ThingsBoard OTA package management.
+
+## Installation
+
+```sh
+uv tool install tbctl
+tbctl --install-completion
+exec zsh
+```
+
+Alternatively with pipx:
+
+```sh
+pipx install tbctl
+```
+
+### Testing pre-releases
+
+Release candidates are published to TestPyPI. Install one with the extra index
+so uv can resolve the runtime dependencies from PyPI:
+
+```sh
+uv tool install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  tbctl
+```
+
+### From a local checkout
+
+To install the working tree instead of the published package, point `uv tool
+install` at the path (a bare `uv tool install tbctl` fails because the package
+is not on the public registry):
+
+```sh
+./generate.sh            # build the generated client (gitignored, bundled into the wheel)
+uv tool install .        # install the current checkout as a uv tool
+tbctl --install-completion
+exec zsh
+```
+
+## Update
+
+```sh
+uv tool upgrade tbctl
+tbctl --install-completion
+exec zsh
+```
+
+For a local checkout, `uv tool upgrade` does not apply; reinstall instead.
+Because the version does not change between builds, `--refresh` is needed to
+bypass the cached wheel:
+
+```sh
+uv tool install . --reinstall --refresh
+```
+
+## Configuration
+
+The quickest way to get started is the interactive wizard, which prompts for the
+URL and token and verifies them against the server before saving:
+
+```sh
+tbctl config init
+```
+
+The individual commands are also available:
+
+```sh
+tbctl config set-url https://thingsboard.example.com
+tbctl config set-token <api-token>
+tbctl config show
+```
+
+Multiple config profiles are supported via `--config <name>` / `-c` (default: `default`).
+
+## Usage
+
+```sh
+tbctl ota list
+tbctl ota list --search firmware --type FIRMWARE --sort-by createdTime --sort-order DESC
+tbctl ota list --version 1.4.0                             # filter by version (client-side)
+tbctl ota list --search app-fw --version 1.4.0             # narrow by title, then version
+tbctl ota list --device-profile <uuid> --type FIRMWARE
+tbctl ota list --json
+
+tbctl ota get <uuid>
+tbctl ota delete <uuid>
+
+tbctl ota upload firmware.bin --title app-fw --version 1.4.0 --device-profile sensor-v2
+tbctl ota upload firmware.bin --title app-sw --version 1.4.0 --type SOFTWARE --device-profile sensor-v2
+tbctl ota upload --url http://host/fw.bin --title app-fw --version 1.4.0 --device-profile sensor-v2
+
+tbctl ota download <uuid>                                   # by package id
+tbctl ota download --device-profile sensor-v2               # profile's assigned firmware
+tbctl ota download --device-profile sensor-v2 --version 1.4.0
+tbctl ota download --device thermostat-01                   # device's firmware (falls back to its profile)
+tbctl ota download --device thermostat-01 --version 1.4.0
+tbctl ota download --name app-fw --latest                   # newest package with this title
+tbctl ota download --name app-fw --version 1.4.0 --type SOFTWARE
+tbctl ota download --name app-fw -o ./out.bin --force       # custom path, overwrite if present
+
+tbctl ota assign app-fw thermostat-01                       # assign latest by title, to a device
+tbctl ota assign app-fw thermostat-01 --version 1.4.0 --type SOFTWARE
+tbctl ota assign <package-uuid> <device-uuid>
+tbctl ota unassign thermostat-01                            # clear the device's FIRMWARE assignment
+tbctl ota unassign thermostat-01 --type SOFTWARE
+
+tbctl device list
+tbctl device list --search sensor --type default --sort-by createdTime --sort-order DESC
+tbctl device list --customer <customer-uuid> --token   # devices of a customer, with access tokens
+tbctl device list --json
+tbctl device get <device>
+tbctl device create sensor-1 --profile default --label Lobby
+tbctl device update sensor-1 --label "Main hall" --profile thermostat
+tbctl device delete sensor-1 --yes
+tbctl device assign sensor-1 --customer <customer-uuid>
+
+tbctl telemetry keys <device>
+tbctl telemetry latest <device> --keys temperature,humidity
+tbctl telemetry history <device> --keys temperature --last 24h
+tbctl telemetry history <device> --keys temperature --start 2026-06-01 --end 2026-06-25
+tbctl telemetry history <device> --keys temperature --last 7d --plot
+
+tbctl attributes get <device>
+tbctl attributes get <device> --scope SERVER_SCOPE --keys fwVersion
+```
+
+`<device>` accepts a device UUID or a device name. Name resolution needs an API
+token with tenant device-read permission; otherwise pass the UUID directly.
+
+`tbctl ota upload` creates a package from exactly one source: a local file
+argument or `--url` for an externally hosted package. `--title`, `--version`,
+and `--device-profile` (name or UUID) are required; `--type` defaults to
+`FIRMWARE`. For file uploads the checksum is computed locally
+(`--checksum-algorithm`, default `SHA256`) and sent alongside the data.
+
+`tbctl ota list --search` maps to ThingsBoard's server-side text search, which
+matches the package title only. Use `--version` for a client-side,
+case-insensitive substring filter on the version; when given, all pages are
+fetched and filtered locally, and it combines with `--search`.
+
+`tbctl ota download` takes exactly one selector (a package id, `--device-profile`,
+`--device`, or `--name`). For a profile or device, the assigned package is used
+unless `--version` is given; for `--name`, the newest version is used unless
+`--version` is given. `--type` defaults to `FIRMWARE` (`--type SOFTWARE` for
+software). Without `-o/--output` the file is saved under the package's own file
+name in the current directory, and an existing file is only overwritten with
+`--force`.
+
+`tbctl ota assign` takes a package id or title and a device. `--type` defaults
+to `FIRMWARE`; with a title, the newest version is used unless `--version` is
+given. `tbctl ota unassign` clears the device's `--type` assignment (default
+`FIRMWARE`).
+
+## Development
+
+```sh
+./generate.sh   # build the client first, so the editable install can see it
+uv sync
+uv run tbctl
+uv run pytest
+pre-commit run --all-files
+```
+
+The editable install only sees `tb_client` if it exists at install time. After
+regenerating the client, refresh the editable path:
+
+```sh
+uv pip install -e . --force-reinstall
+```

tbctl-0.2.0/generated/tb_client/__init__.py

@@ -0,0 +1 @@
+# generated client

tbctl-0.2.0/generated/tb_client/api/__init__.py

@@ -0,0 +1 @@
+# generated