From c10d856129df640f87ee6f962d4478fba9238c2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Delf=20Neum=C3=A4rker?= Date: Thu, 1 Oct 2026 11:14:42 +0200 Subject: [PATCH] Attach a release to the public documentation repo --- README.md | 12 +++++++----- SDK_NATIVE.md | 28 +++++++++++++++++----------- SDK_PYTHON.md | 5 +++++ 3 files changed, 29 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 56fa4ea..a4cbdf2 100644 --- a/README.md +++ b/README.md @@ -56,13 +56,15 @@ What it adds is described where it is relevant: see the internal chapter of the | What | How | |---|---| -| **Public Python wheel** | Self-serve, no credentials — the public package registry | +| **Public Python wheel** | Self-serve, no credentials — the public package registry, or as files from the [releases page](https://git.byonoy.com/public/byonoy_devices_sdk/releases) | +| **Public native SDK** | Self-serve, no credentials — the [releases page](https://git.byonoy.com/public/byonoy_devices_sdk/releases) | | **Internal Python wheel** | On request from Byonoy; installed from the internal registry with a token | -| **Native SDK, either variant** | On request from Byonoy | +| **Internal native SDK** | On request from Byonoy | -Only the public Python wheel is self-serve today. The native archive is not -currently published to a location you can reach without Byonoy handing it to -you, whichever variant you need. +Everything public is self-serve: each release on the +[releases page](https://git.byonoy.com/public/byonoy_devices_sdk/releases) carries the native SDK archive, every Python wheel and +a `SHA256SUMS` file with their checksums. The internal variant is never +published there. The per-form documents cover each of these in detail. diff --git a/SDK_NATIVE.md b/SDK_NATIVE.md index aff9034..778ec15 100644 --- a/SDK_NATIVE.md +++ b/SDK_NATIVE.md @@ -11,14 +11,22 @@ internal variant adds. ## 1. Getting the SDK -**The native SDK is available on request, in either variant.** It is not -published anywhere you can fetch it from without Byonoy providing it. Ask for -the variant you need and you will be given an archive, -`byonoy-devices-public-sdk-.zip` or -`byonoy-devices-internal-sdk-.zip`. +**The public native SDK is a free download.** Each release on the +[releases page](https://git.byonoy.com/public/byonoy_devices_sdk/releases) carries it as `byonoy-devices-public-sdk-.zip`, +next to a `SHA256SUMS` file. No account or token is needed: -If you have been given access to the internal repository's releases, the archive -is attached to each release and can be downloaded with your token: +```bash +TAG=v2026.09.1 +curl -fsSLO "https://git.byonoy.com/public/byonoy_devices_sdk/releases/download/${TAG}/byonoy-devices-public-sdk-${TAG}.zip" +curl -fsSLO "https://git.byonoy.com/public/byonoy_devices_sdk/releases/download/${TAG}/SHA256SUMS" +sha256sum --ignore-missing -c SHA256SUMS # macOS: shasum -a 256 --ignore-missing -c SHA256SUMS +unzip -q "byonoy-devices-public-sdk-${TAG}.zip" -d sdk +``` + +**The internal native SDK is available on request**, as +`byonoy-devices-internal-sdk-.zip`. If you have been given access to +the internal repository's releases, it is attached to each release there and +can be downloaded with your token: ```bash TAG=$(curl -fsS -H "Authorization: token $BYONOY_TOKEN" \ @@ -26,7 +34,7 @@ TAG=$(curl -fsS -H "Authorization: token $BYONOY_TOKEN" \ | python3 -c 'import json,sys; print(json.load(sys.stdin)[0]["tag_name"])') curl -fsSL -H "Authorization: token $BYONOY_TOKEN" -o sdk.zip \ - "https://git.byonoy.com/sw/byonoy_device_library/releases/download/${TAG}/byonoy-devices-public-sdk-${TAG}.zip" + "https://git.byonoy.com/sw/byonoy_device_library/releases/download/${TAG}/byonoy-devices-internal-sdk-${TAG}.zip" unzip -q sdk.zip -d sdk ``` @@ -34,9 +42,7 @@ Use that `releases/download/...` URL; the `/api/v1/.../releases/assets/` endpoint returns `404` on this instance. `limit=1` takes the newest release, which may be a pre-release (a tag with a -`-suffix`). Public archives are attached to final tags; a recent pre-release tag -carries internal artifacts only. Check what a release actually has rather than -assuming. +`-suffix`). Check what a release actually has rather than assuming. --- diff --git a/SDK_PYTHON.md b/SDK_PYTHON.md index 28570d6..9170026 100644 --- a/SDK_PYTHON.md +++ b/SDK_PYTHON.md @@ -47,6 +47,11 @@ python3 -m venv .venv byonoy_devices ``` +The same wheels are attached to each release on the +[releases page](https://git.byonoy.com/public/byonoy_devices_sdk/releases), for machines without access to the registry: download +the one matching your platform and Python version, and install the file +directly (`./.venv/bin/python -m pip install ./byonoy_devices-…whl`). + On **macOS**, `python3` must be 3.13 or 3.14; if it is older, name a supported interpreter explicitly (`python3.13 -m venv .venv`). Over a non-interactive ssh session Homebrew's `/opt/homebrew/bin` is usually not on `PATH`; add it, or