Contributor CLI for Stratum Commons executable notebooks and tool walkthroughs.
Reason this release was yanked:
Release-candidate dry-run for the release pipeline; superseded by 0.2.0
Project description
geotech-cli
geotech-cli is the contributor-facing scaffold for Stratum Commons executable notebooks and tool walkthroughs.
This in-repo scaffold currently supports a narrow Phase 2 contract:
- parse and validate the published YAML front-matter schema
- run a local Python
run(runtime_inputs)function after the front-matter block - persist a recorded output bundle under
.geotech/output/ - submit the bundle to
POST /api/cli/submitusing a bearer token or browser-session-equivalent API token
Source file contract
The CLI expects a source file that starts with a fenced YAML block and then defines Python source code.
---
schema: 1
standard_id: geo.spt.n60_correction
version: 1.0.0
runtime:
target: browser
pyodide: "0.29.4"
inputs:
- id: raw_blow_count
label: Raw blow count
quantity_kind: blow_count
unit: blows/0.3m
outputs:
- id: n60
label: Corrected N60
kind: scalar
quantity_kind: blow_count
unit: blows/0.3m
licence:
code: MIT
audience: practitioner
domain_tags:
- foundations
known_limitations:
- Demonstration scaffold only.
required_packages:
- numpy
lockfile: uv.lock
---
DEFAULT_INPUTS = {
"raw_blow_count": 18,
}
def run(runtime_inputs):
return {
"summary": "Executed local scaffold.",
"scalarOutputs": [
{"id": "n60", "label": "Corrected N60", "value": runtime_inputs["raw_blow_count"], "unit": "blows/0.3m"},
],
}
DEFAULT_INPUTS is optional. The CLI merges repeated --input key=value arguments over those defaults.
Commands
geotech validate notebook.py
geotech run notebook.py --input raw_blow_count=18
geotech submit notebook.py --title "SPT demo" --summary "Demo executable post"
geotech checklist notebook.py
geotech auth save-token stc_pat_...
Notes
validatechecksuv.lock, the manifest schema, runtime hints, optionalmarimo check, and the canonical/standards/<id>/v/<version>route when online.runexecutes the localrun(runtime_inputs)function and writes.geotech/output/<stem>.run.json.submitsynthesizes a minimal publishable markdown body around the validated front-matter and uploads the recorded output bundle to the current platform route.checklistcurrently prints a declaration shell from the manifest metadata; the full standards-bound assumption sync remains a later slice.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file geotech_cli-0.2.0rc1.tar.gz.
File metadata
- Download URL: geotech_cli-0.2.0rc1.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2077ff482d04a8ae768e8a7e495c67ef3a058eb73c1499abfdd123c4df60c1b7
|
|
| MD5 |
328da551b53384c376a89afd6911e560
|
|
| BLAKE2b-256 |
afe80cfd2f76af7f3351c0876a64cc5b6a1d38d5f50bdd58c4b5c9b33b0f48a3
|
Provenance
The following attestation bundles were made for geotech_cli-0.2.0rc1.tar.gz:
Publisher:
geotech-cli-release.yml on stratum-commons-stack/stratum_commons
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
geotech_cli-0.2.0rc1.tar.gz -
Subject digest:
2077ff482d04a8ae768e8a7e495c67ef3a058eb73c1499abfdd123c4df60c1b7 - Sigstore transparency entry: 2117128975
- Sigstore integration time:
-
Permalink:
stratum-commons-stack/stratum_commons@7c201c0716c1164d546aab4a81e7738aa8710b8b -
Branch / Tag:
refs/tags/geotech-cli-v0.2.0rc1 - Owner: https://github.com/stratum-commons-stack
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
geotech-cli-release.yml@7c201c0716c1164d546aab4a81e7738aa8710b8b -
Trigger Event:
push
-
Statement type:
File details
Details for the file geotech_cli-0.2.0rc1-py3-none-any.whl.
File metadata
- Download URL: geotech_cli-0.2.0rc1-py3-none-any.whl
- Upload date:
- Size: 13.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dfaa3924eaad6acf3b80634bc01beb85ccf7ed7a47cc0a1c3288fb7ec91d8164
|
|
| MD5 |
0bed1644f9c136f8bdaa83ec660ee670
|
|
| BLAKE2b-256 |
27da439dbd7e47759761fa0d387a46122ee725a0c0335b95485ab203b9456571
|
Provenance
The following attestation bundles were made for geotech_cli-0.2.0rc1-py3-none-any.whl:
Publisher:
geotech-cli-release.yml on stratum-commons-stack/stratum_commons
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
geotech_cli-0.2.0rc1-py3-none-any.whl -
Subject digest:
dfaa3924eaad6acf3b80634bc01beb85ccf7ed7a47cc0a1c3288fb7ec91d8164 - Sigstore transparency entry: 2117129036
- Sigstore integration time:
-
Permalink:
stratum-commons-stack/stratum_commons@7c201c0716c1164d546aab4a81e7738aa8710b8b -
Branch / Tag:
refs/tags/geotech-cli-v0.2.0rc1 - Owner: https://github.com/stratum-commons-stack
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
geotech-cli-release.yml@7c201c0716c1164d546aab4a81e7738aa8710b8b -
Trigger Event:
push
-
Statement type: