kub-cli 0.2.0__py3-none-any.whl

kub_cli-0.2.0.dist-info/METADATA

@@ -0,0 +1,344 @@
+Metadata-Version: 2.4
+Name: kub-cli
+Version: 0.2.0
+Summary: Thin Python CLI wrappers for kub containerized apps (Apptainer + Docker)
+Project-URL: Homepage, https://github.com/feelpp/kub-cli
+Project-URL: Repository, https://github.com/feelpp/kub-cli
+Project-URL: Issues, https://github.com/feelpp/kub-cli/issues
+Author: kub-cli contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: apptainer,cli,docker,hpc,simulation,wrapper
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Requires-Dist: typer<1.0,>=0.12
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=7.4; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: reuse>=5.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2026 University of Strasbourg
+SPDX-FileContributor: Christophe Prud'homme
+SPDX-FileContributor: Cemosis
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# kub-cli
+
+`kub-cli` is a thin Python client that exposes stable native commands for KUB tools while executing the real logic inside container images.
+
+- `kub-dataset`
+- `kub-simulate`
+- `kub-dashboard`
+- `kub-img`
+
+The wrapper does not reimplement dataset/simulation/dashboard business logic. It resolves configuration, builds runtime commands, and executes them.
+
+License: Apache-2.0.
+
+## Why this exists
+
+`kub-cli` provides a consistent command-line UX across laptops, workstations, CI, and HPC environments.
+
+## Runtime model
+
+Supported runtimes:
+
+- `apptainer`
+- `docker`
+- `auto`
+
+Policy:
+
+- Apptainer remains the preferred runtime for HPC / Slurm / MPI-oriented execution.
+- Docker is supported for local/workstation/CI usage.
+- `auto` prefers Apptainer when configured and available, then falls back to Docker.
+
+Default behavior:
+
+- Default runtime is `auto`.
+- In `auto`, kub-cli checks Apptainer first, then Docker.
+- If neither runtime is installed, kub-cli reports how to install them.
+
+## Installation
+
+### From source
+
+```bash
+python -m pip install .
+```
+
+### Editable install for development
+
+```bash
+python -m pip install -e .[dev]
+```
+
+## Quick start
+
+Set runtime and images:
+
+```bash
+export KUB_RUNTIME=auto
+export KUB_IMAGE_DOCKER=ghcr.io/feelpp/ktirio-urban-building:master
+export KUB_IMAGE_APPTAINER=/path/to/ktirio-urban-building.sif
+```
+
+Then use wrapper commands:
+
+```bash
+kub-simulate --runtime docker -- run case.yaml
+kub-dataset --runtime apptainer -- push ./data
+kub-dashboard --runtime auto -- serve ./results
+```
+
+## Command behavior
+
+For Apptainer runtime:
+
+```text
+apptainer run [common options] --app <wrapped-app> <local-sif-image> [forwarded args...]
+```
+
+For Docker runtime:
+
+```text
+docker run --rm [common options] <docker-image> <wrapped-app> [forwarded args...]
+```
+
+Mappings:
+
+- `kub-dataset` -> `kub-dataset`
+- `kub-simulate` -> `kub-simulate`
+- `kub-dashboard` -> `kub-dashboard`
+
+All non-wrapper arguments are forwarded transparently to the in-container app.
+
+## Wrapper options
+
+Available on all three wrapper commands:
+
+- `--runtime {auto,apptainer,docker}`
+- `--image IMAGE`
+- `--bind SRC:DST` (repeatable)
+- `--pwd PATH`
+- `--runner PATH`
+- `--apptainer-flag FLAG` (repeatable)
+- `--docker-flag FLAG` (repeatable)
+- `--env KEY=VALUE` (repeatable)
+- `--dry-run`
+- `--verbose / --no-verbose`
+- `--show-config`
+- `--version`
+
+Use `--` to force all remaining arguments to be forwarded:
+
+```bash
+kub-simulate --runtime docker -- --help
+```
+
+## Image model
+
+Canonical upstream reference is Docker/OCI.
+
+Example Docker image:
+
+```text
+ghcr.io/feelpp/ktirio-urban-building:master
+```
+
+Derived Apptainer remote source:
+
+```text
+oras://ghcr.io/feelpp/ktirio-urban-building:master-sif
+```
+
+Default image references used when no explicit image is configured:
+
+- Docker: `ghcr.io/feelpp/ktirio-urban-building:master`
+- Apptainer: `oras://ghcr.io/feelpp/ktirio-urban-building:master-sif`
+
+Other tags are supported (for example `pr-<nnn>`), e.g.:
+
+- Docker: `ghcr.io/feelpp/ktirio-urban-building:pr-456`
+- Apptainer source: `oras://ghcr.io/feelpp/ktirio-urban-building:pr-456-sif`
+
+Important:
+
+- For Apptainer download/pull, use `oras://...`.
+- Do not use `docker://...` for Apptainer pulls in this workflow.
+
+## kub-img
+
+`kub-img` is the image utility command used by `kub-cli` internals for image pull/info workflows.
+
+Subcommands:
+
+- `kub-img pull [SOURCE] [--runtime ...] [--image ...]`
+- `kub-img info [--runtime ...] [--image ...] [--json]`
+- `kub-img apps` (Apptainer runtime)
+- `kub-img path`
+
+Examples:
+
+```bash
+# Docker pull
+kub-img pull --runtime docker --image ghcr.io/feelpp/ktirio-urban-building:master
+
+# Apptainer pull with ORAS source
+kub-img pull oras://ghcr.io/feelpp/ktirio-urban-building:master-sif \
+  --runtime apptainer \
+  --image ./ktirio-urban-building.sif
+
+# Runtime-aware image info
+kub-img info --runtime docker --image ghcr.io/feelpp/ktirio-urban-building:master --json
+kub-img info --runtime apptainer --image ./ktirio-urban-building.sif
+```
+
+## Configuration
+
+Precedence (highest to lowest):
+
+1. CLI options
+2. Environment variables
+3. Project config: `.kub-cli.toml` in current working directory
+4. User config: `~/.config/kub-cli/config.toml`
+5. Built-in defaults
+
+### Environment variables
+
+- `KUB_RUNTIME` : `auto|apptainer|docker`
+- `KUB_IMAGE_DOCKER` : Docker image reference
+- `KUB_IMAGE_APPTAINER` : Apptainer image path (local SIF)
+- `KUB_IMAGE` : legacy generic image fallback (backward compatibility)
+- `KUB_BIND` : additional binds, comma- or semicolon-separated
+- `KUB_WORKDIR` : runtime working directory
+- `KUB_APP_RUNNER` : generic runner override
+- `KUB_APPTAINER_RUNNER` : Apptainer runner override
+- `KUB_DOCKER_RUNNER` : Docker runner override
+- `KUB_VERBOSE` : boolean (`true/false`, `1/0`, `yes/no`, `on/off`)
+- `KUB_APPTAINER_FLAGS` : extra Apptainer flags (shell-split)
+- `KUB_DOCKER_FLAGS` : extra Docker flags (shell-split)
+
+### Config file format
+
+You can place config at:
+
+- `~/.config/kub-cli/config.toml`
+- `.kub-cli.toml`
+
+Keys may be top-level or under `[kub_cli]`.
+
+```toml
+[kub_cli]
+runtime = "auto"
+workdir = "/work"
+verbose = false
+
+[kub_cli.image]
+docker = "ghcr.io/feelpp/ktirio-urban-building:master"
+apptainer = "./ktirio-urban-building.sif"
+
+[kub_cli.env]
+OMP_NUM_THREADS = "8"
+```
+
+## Backward compatibility
+
+`kub-cli` keeps compatibility with existing Apptainer-centric usage:
+
+- Existing `KUB_IMAGE` still works as a fallback image setting.
+- Existing Apptainer command flow remains unchanged when runtime resolves to `apptainer`.
+- Existing wrapper UX and argument forwarding semantics are preserved.
+
+For explicit multi-runtime setups, prefer `KUB_IMAGE_DOCKER` and `KUB_IMAGE_APPTAINER`.
+
+## Troubleshooting
+
+- Docker runtime selected but Docker missing: install Docker or set `--runner`.
+- Apptainer runtime selected but Apptainer missing: install Apptainer or set `--runner`.
+- No image configured for selected runtime: set `--image`, runtime-specific env vars, or config.
+- Need to inspect resolved command: use `--dry-run`.
+
+## Development
+
+```bash
+uv venv .venv
+. .venv/bin/activate
+uv pip install -e '.[dev]'
+pytest
+```
+
+Version bumping for maintainers:
+
+```bash
+# bump patch/minor/major from pyproject version
+kub-cli bump patch
+kub-cli bump minor
+kub-cli bump major
+
+# explicit target version
+kub-cli bump patch --to 0.2.0
+
+# preview only
+kub-cli bump patch --dry-run
+```
+
+Release versioning policy:
+
+- `kub-cli` uses SemVer (`MAJOR.MINOR.PATCH`).
+- Release tags must be `vMAJOR.MINOR.PATCH`.
+- The tag version must match `project.version` in `pyproject.toml`.
+
+PyPI publishing via GitHub environment:
+
+- Workflow: `.github/workflows/publish.yml`
+- Trigger: publish a GitHub Release (SemVer tag, for example `v0.2.0`) or run `workflow_dispatch`.
+- Publish job uses GitHub `environment: pypi` and OpenID Connect trusted publishing (no PyPI API token needed in GitHub secrets).
+- Publishing is restricted to the official repository `feelpp/kub-cli`.
+
+One-time setup:
+
+1. In GitHub repository settings, create environment `pypi`.
+2. In PyPI Organizations, ensure project `kub-cli` belongs to organization `feelpp`.
+3. In the `kub-cli` PyPI project settings (under organization `feelpp`), add a trusted publisher bound to:
+   - owner/repository: `feelpp/kub-cli`
+   - workflow: `publish.yml`
+   - environment: `pypi`
+4. Ensure the first trusted release tag already exists in the repository.
+
+Release steps:
+
+```bash
+# 1) bump version in source tree
+kub-cli bump patch
+
+# 2) commit + tag matching SemVer version
+git add pyproject.toml src/kub_cli/__init__.py
+git commit -m "Release 0.1.1"
+git tag v0.1.1
+git push origin main --tags
+
+# 3) publish GitHub Release (this triggers PyPI workflow)
+gh release create v0.1.1 --generate-notes
+```
+
+The workflow validates the tag format and checks that it matches `pyproject.toml` before building and publishing to PyPI.
+
+## License
+
+This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE).

kub_cli-0.2.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+kub_cli/__init__.py,sha256=ovSfERf0-puWxHiA6283pq19RZqXZjIBmml9nA9BOpw,385
+kub_cli/__main__.py,sha256=1baMCBHrZocbxMkL3g4umjJ6kfBGkRLHkw1Pr1cPbHk,293
+kub_cli/cli.py,sha256=cJSdy_OsOQCNfEVUc2YSc8oVkj2phU7eYbpjSTkS_D8,8122
+kub_cli/commands.py,sha256=cc0DNVfRlX-O9-GjbXasi3VB8BXoOxBL_CG9LWyTOgk,4695
+kub_cli/config.py,sha256=b2EPQ8k-xquggm7Zy9DeK3FKMQ62QfVnxKYsUD_sWFk,18118
+kub_cli/errors.py,sha256=LYgHj1Zcxrf9nyphod_LDCl1mIyJmHg-xAQuI7PkQ-A,886
+kub_cli/img_cli.py,sha256=GF4YC-UDgtETl8PmsXwtcRGVEQzPLe-NMeKDGHSoWsw,7910
+kub_cli/img_integration.py,sha256=1EIHLErJEn4iDEu5cBMZweGZzvtDCLosbsHrp3eMcQk,8295
+kub_cli/img_tools.py,sha256=VD-7-nIYAO4aHGzlh1mKfRYJSb6w1wsOqjvBNRNtda0,14467
+kub_cli/logging_utils.py,sha256=3sKhn4B3RM-G0s6qmhrRQPGqmQk0Q7226Mth2q5-Koo,871
+kub_cli/runtime.py,sha256=UwdsaitTPBl_Y7axXWLEXfCeYpfAkltS9df4t1015yg,14577
+kub_cli/versioning.py,sha256=g-GxC4bA7oLwCkgGEeFH_VRbvdvcZ8VVfvUSw5unVjE,4623
+kub_cli-0.2.0.dist-info/METADATA,sha256=BSkyiTDo-feHC21v_YIrUct9zgSazRm5yH5IxNNySlE,9442
+kub_cli-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+kub_cli-0.2.0.dist-info/entry_points.txt,sha256=13ESBP4SSB6ttsWNbat21cCA1sXtPGtL02JdpZu8xS0,203
+kub_cli-0.2.0.dist-info/licenses/LICENSE,sha256=Nv12NASP7uu6hquVGQFUGL1bZxHh3aH1Tj_rMjCYoI0,11522
+kub_cli-0.2.0.dist-info/RECORD,,

kub_cli-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

kub_cli-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+kub-cli = kub_cli.cli:metaMain
+kub-dashboard = kub_cli.cli:dashboardMain
+kub-dataset = kub_cli.cli:datasetMain
+kub-img = kub_cli.img_cli:imgMain
+kub-simulate = kub_cli.cli:simulateMain

kub_cli-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,206 @@
+SPDX-FileCopyrightText: 2026 University of Strasbourg
+SPDX-FileContributor: Christophe Prud'homme
+SPDX-FileContributor: Cemosis
+SPDX-License-Identifier: Apache-2.0
+
+                                 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.