Merge branch 'aman/add-first-content'

Author: aman

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -39,3 +39,10 @@ htmlcov/
 # OS
 .DS_Store
 Thumbs.db
+
+## API generator
+.ruff_cache/
+openapi.json
+openapi.codegen.json
+
+.env

README.md

@@ -4,7 +4,7 @@ Python SDK for the BodyLoop API for seamless ecosystem integration
 
 The URL of the source repository <https://github.com/bodyloop/bodyloop-sdk-python> has suffix `python` to enable adding SDKs for other lanuages such as JavaScript/TypeScript, C/C++, Rust, etc.
 
-The distribution name (install) of the Python Package name is `bodyloop-sdk` and is available in the global Package Index PyPi at <https://pypi.org/project/bodyloop-sdk>. It omits the suffix since PyPi already tells us that we are in the Python ecosystem. 
+The distribution name (install) of the Python Package name is `bodyloop-sdk` and is available in the global Package Index PyPi at <https://pypi.org/project/bodyloop-sdk>. It omits the suffix since PyPi already tells us that we are in the Python ecosystem.
 
 Examples how to get the package are:
 
@@ -27,7 +27,7 @@ Usage:
 ```python
 import bodyloop
 from bodyloop import Viatar, Proband
-from bodyloop import System as BodyLoopSystem
+from bodyloop import ScanUnit
 ```
 
 ## Contribute
@@ -42,3 +42,33 @@ uv sync
 uv run pytest
 uv build
 ```
+
+The release / publish workflow is defined as:
+
+- Push to the `main` branch
+- Create a new tag `vYYYY.MM.DD.r` where `YYYY.MM.DD` is the current date and `r` is the sequential release number we increment over all releases, independent of the date and push the tag as well.
+- Create a new GitHub release based on that tag, baptize the release identical to the tag and add release notes.
+- Triggered by the release creation the GitHub Action `publish.yml` will build the package and publish it to PyPi.
+
+Update the API client
+
+The API generator <https://pypi.org/project/openapi-python-client/> is used.
+
+```bash
+./generate_api_client.sh <ip_or_hostname_of_my_bodyloop_instance>
+```
+
+Use the experiments to get your feet wet:
+
+```bash
+touch .env
+echo "BODYLOOP_BASE_URL='https://bodyloop-control-pc'" >> .env
+echo "BODYLOOP_API_TOKEN='your_api_token_here'" >> .env
+
+uv run experiments/a_create_client.py
+uv run experiments/b_load_probands.py
+```
+
+## License
+
+See [LICENSE](LICENSE)

experiments/a_create_client.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+from pathlib import Path
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Add the src directory (src-layout project) so `bodyloop_sdk` can be imported
+sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "src"))
+
+from bodyloop_sdk.client import AuthenticatedClient
+
+base_url = os.getenv("BODYLOOP_BASE_URL")
+api_token = os.getenv("BODYLOOP_API_TOKEN")
+
+# Create a client with SSL verification disabled for local IP
+# Note: In production, you should use proper SSL certificates
+client = AuthenticatedClient(
+    base_url=base_url,
+    verify_ssl=False,
+    token=api_token,
+    timeout=10.0
+)
+
+print(f"Client configured for: {base_url}")

experiments/b_load_probands.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+from pathlib import Path
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Add the src directory (src-layout project) so `bodyloop_sdk` can be imported
+sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "src"))
+
+from bodyloop_sdk.client import AuthenticatedClient
+
+base_url = os.getenv("BODYLOOP_BASE_URL")
+api_token = os.getenv("BODYLOOP_API_TOKEN")
+
+# (a) Create a client with SSL verification disabled for local IP)
+client = AuthenticatedClient(
+    base_url=base_url,
+    verify_ssl=False,
+    token=api_token,
+    timeout=10.0
+)
+
+print(f"Client configured for: {base_url}")
+
+
+# (b) Load probands
+from functools import partial
+from bodyloop_sdk.client.api.probands import get_probands_api_v2_probands_get
+
+get_probands = partial(get_probands_api_v2_probands_get.sync, client=client)
+
+probands = get_probands() or []
+print(f"Total probands: {len(probands)}\n")
+
+# Print first and last proband for sanity check
+if probands:
+    print("First proband:")
+    print(probands[0])
+    print("\nLast proband:")
+    print(probands[-1])
+
+import json
+if probands:
+    print("First proband:")
+    print(json.dumps(probands[0].to_dict(), indent=2))
+    print("\nLast proband:")
+    print(json.dumps(probands[-1].to_dict(), indent=2))

generate-api-client.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+HOSTNAME=${1:-bodyloop-control-pc}
+
+curl -kO https://${HOSTNAME}/api/v2/openapi.json
+
+# Optionally beautify the JSON file with jq
+mv openapi.json openapi_tmp.json && jq . openapi_tmp.json > openapi.json && rm openapi_tmp.json
+
+# Generate the API client code
+mkdir -p src/bodyloop_sdk/api
+
+# Normalize OpenAPI for openapi-python-client compatibility
+uv run python scripts/prepare_openapi_for_codegen.py --input openapi.json --output openapi.codegen.json
+
+uv run --with openapi-python-client python -m openapi_python_client generate --overwrite --config generate-api-client.yml --path openapi.codegen.json --output-path src/bodyloop_sdk
+
+mv src/bodyloop_sdk/README.md src/bodyloop_sdk/client/
+
+rm src/bodyloop_sdk/.gitignore
+rm src/bodyloop_sdk/pyproject.toml
+rm -rf src/bodyloop_sdk/client/.ruff_cache/

generate-api-client.yml

@@ -0,0 +1,9 @@
+project_name_override: client
+package_name_override: client
+class_overrides:
+  _PrivateInternalLongName:
+    class_name: ShortName
+    module_name: short_name
+docstrings_on_attributes: true
+literal_enums: true
+generate_all_tags: true