Merge branch 'copilot/create-boilerplate-code'

Author: aman

.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "name": "bodyloop-sdk",
+  "image": "mcr.microsoft.com/devcontainers/python:3.12",
+  "features": {
+    "ghcr.io/astral-sh/uv/devcontainer-feature/uv:latest": {}
+  },
+  "postCreateCommand": "uv sync",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "GitHub.copilot",
+        "GitHub.copilot-chat"
+      ],
+      "settings": {
+        "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+        "editor.formatOnSave": true,
+        "[python]": {
+          "editor.defaultFormatter": "ms-python.python"
+        }
+      }
+    }
+  }
+}

.github/copilot-instructions.md

@@ -0,0 +1,44 @@
+# GitHub Copilot Instructions
+
+## Project Overview
+
+`bodyloop-sdk-*` is the pattern for the repositories of the SDKs 
+for the BodyLoop API for certain languages.
+
+This repository, `bodyloop-sdk-python` implements the one for Python.
+
+## Spec-Driven Development Workflow
+
+REVIEW: Defect, major: Does not apply SDD in a correct way. Does not describe the workflow we intend. 
+
+1. **Spec** – Write a detailed docstring describing the function/class contract
+   (inputs, outputs, raised exceptions, edge cases) before any implementation.
+2. **Implement** – Ask Copilot to generate the implementation that satisfies the spec.
+3. **Test** – Ask Copilot to generate `pytest` tests covering the spec.
+4. **Review** – Verify Copilot output matches the spec; adjust as needed.
+
+## Code Style
+
+- Python ≥ 3.11; use type hints on all public APIs.
+- Keep the `src/bodyloop_sdk/` layout; add new modules inside that package.
+- Use `snake_case` for functions/variables, `PascalCase` for classes.
+- Keep public APIs small and composable; prefer pure functions.
+
+## Testing
+
+- All tests live in `tests/`; mirror the source module structure.
+- Every public function must have at least one happy-path test and one
+  error/edge-case test.
+- Run tests with: `uv run pytest`
+
+## Dependency Management
+
+- Manage dependencies with `uv`; edit `pyproject.toml` directly.
+- Add runtime deps: `uv add <package>`
+- Add dev deps: `uv add --dev <package>`
+
+## Release Process
+
+- Bump `__version__` in `src/bodyloop_sdk/__init__.py`.
+- Create a GitHub release tagged `vX.Y.Z`.
+- The `release.yml` workflow will build and publish to PyPI automatically.

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests
+        run: uv run pytest

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write  # required for PyPI trusted publishing
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/project/bodyloop-sdk/
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg
+*.egg-info/
+dist/
+build/
+eggs/
+parts/
+var/
+sdist/
+develop-eggs/
+.installed.cfg
+lib/
+lib64/
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# uv
+.uv/
+
+# pytest
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Editors
+.vscode/settings.json
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

README.md

@@ -1,2 +1,44 @@
-# bodyloop-pypi
+# BodyLoop SDK for Python
+
 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. 
+
+Examples how to get the package are:
+
+```bash
+pip install bodyloop-sdk
+
+poetry add bodyloop-sdk
+
+uv add bodyloop-sdk
+
+pipx install bodyloop-sdk
+
+uv tool install bodyloop-sdk
+```
+
+The top-level import of the package is the Python module `bodyloop`.
+
+Usage:
+
+```python
+import bodyloop
+from bodyloop import Viatar, Proband
+from bodyloop import System as BodyLoopSystem
+```
+
+## Contribute
+
+Local workflow
+
+```bash
+git clone git@github.com:BodyLoop/bodyloop-sdk-python.git
+cd bodyloop-sdk-python
+
+uv sync
+uv run pytest
+uv build
+```

pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "bodyloop-sdk"
+version = "2026.03.05.1"
+description = "Python SDK for the BodyLoop API for seamless ecosystem integration"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/BodyLoop/bodyloop-pypi"
+Repository = "https://github.com/BodyLoop/bodyloop-pypi"
+Issues = "https://github.com/BodyLoop/bodyloop-pypi/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bodyloop_sdk"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+]

src/bodyloop_sdk/__init__.py

@@ -0,0 +1,17 @@
+"""BodyLoop SDK – Python client for the BodyLoop API."""
+
+from __future__ import annotations
+
+try:
+    # Python 3.8+
+    from importlib.metadata import version as _pkg_version
+except ImportError:  # pragma: no cover (for very old Pythons)
+    from importlib_metadata import version as _pkg_version  # type: ignore
+
+
+def _read_version() -> str:
+    # This must match the distribution name in pyproject.toml ([project].name)
+    return _pkg_version("bodyloop-sdk")
+
+
+__version__ = _read_version()

tests/__init__.py

@@ -0,0 +1,16 @@
+"""Tests for the bodyloop_sdk package."""
+
+import bodyloop_sdk
+
+
+def test_version_exists():
+    """The package exposes a __version__ string."""
+    assert hasattr(bodyloop_sdk, "__version__")
+    assert isinstance(bodyloop_sdk.__version__, str)
+
+
+def test_version_format():
+    """__version__ follows semver major.minor.patch format."""
+    parts = bodyloop_sdk.__version__.split(".")
+    assert len(parts) == 4
+    assert all(part.isdigit() for part in parts)