Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .devcontainer/devcontainer.json
Original file line numberDiff line numberDiff line change
@@ -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"
}
}
}
}
}
44 changes: 44 additions & 0 deletions .github/copilot-instructions.md
Original file line numberDiff line numberDiff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line numberDiff line numberDiff line change
@@ -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
41 changes: 41 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
@@ -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
44 changes: 43 additions & 1 deletion README.md
Original file line numberDiff line numberDiff line change
@@ -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
```
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
@@ -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",
]
17 changes: 17 additions & 0 deletions src/bodyloop_sdk/__init__.py
Original file line numberDiff line numberDiff line change
@@ -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()
Empty file addedtests/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions tests/test_bodyloop_sdk.py
Original file line numberDiff line numberDiff line change
@@ -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)
79 changes: 79 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.