renpho-py 1.0.0__tar.gz

renpho_py-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 danvaneijck (original renpho-api)
+Copyright (c) 2026 ChocoTonic (renpho-py and subsequent modifications)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

renpho_py-1.0.0/NOTICE

@@ -0,0 +1,16 @@
+renpho-py
+========
+
+This project began as a copy of the MIT-licensed `renpho-api`
+(https://github.com/danvaneijck/renpho-api) by danvaneijck, and is now
+independently maintained. The original license and copyright are preserved in
+LICENSE.
+
+The underlying Renpho cloud API was reverse-engineered; the approach and
+protocol details are based on RenphoGarminSync-CLI
+(https://github.com/forkerer/RenphoGarminSync-CLI).
+
+renpho-py is UNOFFICIAL and is not affiliated with, endorsed by, or supported by
+Renpho or any of its affiliates. "Renpho" is a trademark of its respective
+owner and is used here only to describe the API this client targets. Use at
+your own risk and in accordance with Renpho's terms of service.

renpho_py-1.0.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: renpho-py
+Version: 1.0.0
+Summary: Unofficial Renpho Health API client for Python — pull body composition data from Renpho smart scales.
+Author: ChocoTonic
+Maintainer: ChocoTonic
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ChocoTonic/renpho-py
+Project-URL: Repository, https://github.com/ChocoTonic/renpho-py
+Project-URL: Issues, https://github.com/ChocoTonic/renpho-py/issues
+Project-URL: Changelog, https://github.com/ChocoTonic/renpho-py/blob/main/CHANGELOG.md
+Keywords: renpho,renpho-api,health,body-composition,smart-scale,api-client,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: requests>=2.28
+Requires-Dist: pycryptodome>=3.15
+Provides-Extra: dotenv
+Requires-Dist: python-dotenv>=1.0; extra == "dotenv"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# renpho-py — Renpho Health API client for Python
+
+[![PyPI](https://img.shields.io/pypi/v/renpho-py)](https://pypi.org/project/renpho-py/)
+[![CI](https://github.com/ChocoTonic/renpho-py/actions/workflows/ci.yml/badge.svg)](https://github.com/ChocoTonic/renpho-py/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/pypi/pyversions/renpho-py)](https://pypi.org/project/renpho-py/)
+
+Unofficial **Renpho Health API** client for **Python**. Pull body composition
+measurements from Renpho smart scales programmatically.
+
+> **Unofficial.** Not affiliated with, endorsed by, or supported by Renpho. Use
+> at your own risk and in line with Renpho's terms of service.
+
+`renpho-py` is an independently maintained continuation of the abandoned
+[`renpho-api`](https://github.com/danvaneijck/renpho-api) (MIT). The import name
+is unchanged, so migrating is a one-line swap — `pip install renpho-py` and your
+existing `from renpho import ...` code keeps working. The underlying API was
+reverse-engineered; protocol details are based on
+[RenphoGarminSync-CLI](https://github.com/forkerer/RenphoGarminSync-CLI).
+
+## Installation
+
+```bash
+pip install renpho-py
+```
+
+For `.env` file support (recommended for CLI usage):
+
+```bash
+pip install "renpho-py[dotenv]"
+```
+
+> Migrating from `renpho-api`? `pip uninstall renpho-api && pip install renpho-py`.
+> No code changes — you still `from renpho import RenphoClient`.
+
+## CLI Usage
+
+1. Create a `.env` file (or export the variables):
+
+```
+RENPHO_EMAIL=your@email.com
+RENPHO_PASSWORD=your_plain_text_password
+```
+
+2. Run the CLI:
+
+```bash
+renpho
+```
+
+This will log in, discover your scales, fetch all measurements, print the 5 most recent, and save everything to `renpho_data/` as JSON and CSV.
+
+### Environment variables
+
+| Variable | Required | Description |
+| --- | --- | --- |
+| `RENPHO_EMAIL` | Yes | Your Renpho account email |
+| `RENPHO_PASSWORD` | Yes | Your Renpho account password |
+| `RENPHO_DEBUG` | No | Set to `1` to print API request/response details |
+| `RENPHO_OUTPUT_DIR` | No | Output directory (default: `renpho_data`) |
+
+## Library Usage
+
+```python
+from renpho import RenphoClient
+
+client = RenphoClient("user@example.com", "password")
+client.login()
+
+# Fetch all measurements in one call
+measurements = client.get_all_measurements()
+
+for m in measurements:
+    print(m["weight"], m.get("bodyfat"), m.get("muscle"))
+```
+
+### Step-by-step control
+
+```python
+from renpho import RenphoClient, save_json, save_csv
+
+client = RenphoClient("user@example.com", "password")
+client.login()
+
+# Get device/scale info
+device_info = client.get_device_info()
+scales = device_info["scale"]
+
+# Fetch from a specific scale table
+# Use get_body_composition_measurements() for scales with impedance sensors
+# (body fat, muscle, etc.) — the server-side count is unreliable for these.
+# Fall back to get_measurements() for weight-only scales.
+table = scales[0]
+measurements = client.get_body_composition_measurements(
+    table_name=table["tableName"],
+    user_id=client.user_id,
+)
+if not measurements:
+    measurements = client.get_measurements(
+        table_name=table["tableName"],
+        user_id=client.user_id,
+        total_count=table["count"],
+    )
+
+# Export
+save_json(measurements, "my_data.json")
+save_csv(measurements, "my_data.csv")
+```
+
+### Multiple Renpho accounts on one email
+
+Some users end up with **two Renpho accounts under the same email** — for
+example after the Google SSO migration created an orphan account, or after
+re-registering. Each account has its own user ID and its own measurement
+table, so the default `get_all_measurements()` will only return data from
+the account you log in to.
+
+If you know the other account's user ID, pass it in:
+
+```python
+measurements = client.get_all_measurements(
+    extra_user_ids=["5975813831868809088"],
+)
+```
+
+The library will probe every measurement table for that user ID, fetch
+matching records, and dedupe by record `id` so you get a single combined
+timeline.
+
+**How to find your other user ID:**
+
+Unfortunately there is no first-party API endpoint that lists "all
+accounts associated with this email" — Renpho treats accounts as
+independent even when emails collide. Options:
+
+1. **Renpho support** — email them and ask for your user ID(s) on file
+2. **Inspect the iOS / Android app** — sign in to the other account in
+   the official app and look in Settings / Account / Help → Feedback
+   pages (the user ID is sometimes visible there)
+3. **Capture network traffic** — proxy the official app through
+   mitmproxy, sign in, and look at any request body containing
+   `userId` (decrypt with the published AES-128 key — see the
+   reverse-engineering write-up linked at the top of this README)
+
+Once you have the ID, save it alongside your credentials and you won't
+need to discover it again.
+
+### Error handling
+
+```python
+from renpho import RenphoClient, RenphoAPIError
+
+client = RenphoClient("user@example.com", "wrong_password")
+try:
+    client.login()
+except RenphoAPIError as e:
+    print(f"API error: {e}")
+```
+
+## Available Metrics
+
+Each measurement dict can contain these fields (availability depends on your scale model):
+
+| Key | Description | Unit |
+| --- | --- | --- |
+| `weight` | Weight | kg |
+| `bmi` | BMI | |
+| `bodyfat` | Body Fat | % |
+| `water` | Body Water | % |
+| `muscle` | Muscle Mass | % |
+| `bone` | Bone Mass | % |
+| `bmr` | Basal Metabolic Rate | kcal/day |
+| `visfat` | Visceral Fat | level |
+| `subfat` | Subcutaneous Fat | % |
+| `protein` | Protein | % |
+| `bodyage` | Body Age | years |
+| `sinew` | Lean Body Mass | kg |
+| `fatFreeWeight` | Fat Free Weight | kg |
+| `heartRate` | Heart Rate | bpm |
+| `cardiacIndex` | Cardiac Index | |
+| `bodyShape` | Body Shape | |
+
+## Project Structure
+
+```
+renpho-py/
+├── pyproject.toml        # Package config & dependencies (dist name: renpho-py)
+├── README.md
+├── CHANGELOG.md
+├── LICENSE               # MIT (original + current attribution)
+├── NOTICE
+├── renpho/               # import name — unchanged for drop-in migration
+│   ├── __init__.py       # Public API exports
+│   ├── py.typed          # PEP 561 typing marker
+│   ├── client.py         # RenphoClient class
+│   ├── cli.py            # CLI entry point
+│   ├── constants.py      # API endpoints, device types, metrics
+│   ├── crypto.py         # AES encryption/decryption
+│   └── export.py         # JSON/CSV export helpers
+├── tests/                # Unit tests
+└── .github/workflows/    # CI + PyPI release automation (trusted publishing)
+```

renpho_py-1.0.0/README.md

@@ -0,0 +1,201 @@
+# renpho-py — Renpho Health API client for Python
+
+[![PyPI](https://img.shields.io/pypi/v/renpho-py)](https://pypi.org/project/renpho-py/)
+[![CI](https://github.com/ChocoTonic/renpho-py/actions/workflows/ci.yml/badge.svg)](https://github.com/ChocoTonic/renpho-py/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/pypi/pyversions/renpho-py)](https://pypi.org/project/renpho-py/)
+
+Unofficial **Renpho Health API** client for **Python**. Pull body composition
+measurements from Renpho smart scales programmatically.
+
+> **Unofficial.** Not affiliated with, endorsed by, or supported by Renpho. Use
+> at your own risk and in line with Renpho's terms of service.
+
+`renpho-py` is an independently maintained continuation of the abandoned
+[`renpho-api`](https://github.com/danvaneijck/renpho-api) (MIT). The import name
+is unchanged, so migrating is a one-line swap — `pip install renpho-py` and your
+existing `from renpho import ...` code keeps working. The underlying API was
+reverse-engineered; protocol details are based on
+[RenphoGarminSync-CLI](https://github.com/forkerer/RenphoGarminSync-CLI).
+
+## Installation
+
+```bash
+pip install renpho-py
+```
+
+For `.env` file support (recommended for CLI usage):
+
+```bash
+pip install "renpho-py[dotenv]"
+```
+
+> Migrating from `renpho-api`? `pip uninstall renpho-api && pip install renpho-py`.
+> No code changes — you still `from renpho import RenphoClient`.
+
+## CLI Usage
+
+1. Create a `.env` file (or export the variables):
+
+```
+RENPHO_EMAIL=your@email.com
+RENPHO_PASSWORD=your_plain_text_password
+```
+
+2. Run the CLI:
+
+```bash
+renpho
+```
+
+This will log in, discover your scales, fetch all measurements, print the 5 most recent, and save everything to `renpho_data/` as JSON and CSV.
+
+### Environment variables
+
+| Variable | Required | Description |
+| --- | --- | --- |
+| `RENPHO_EMAIL` | Yes | Your Renpho account email |
+| `RENPHO_PASSWORD` | Yes | Your Renpho account password |
+| `RENPHO_DEBUG` | No | Set to `1` to print API request/response details |
+| `RENPHO_OUTPUT_DIR` | No | Output directory (default: `renpho_data`) |
+
+## Library Usage
+
+```python
+from renpho import RenphoClient
+
+client = RenphoClient("user@example.com", "password")
+client.login()
+
+# Fetch all measurements in one call
+measurements = client.get_all_measurements()
+
+for m in measurements:
+    print(m["weight"], m.get("bodyfat"), m.get("muscle"))
+```
+
+### Step-by-step control
+
+```python
+from renpho import RenphoClient, save_json, save_csv
+
+client = RenphoClient("user@example.com", "password")
+client.login()
+
+# Get device/scale info
+device_info = client.get_device_info()
+scales = device_info["scale"]
+
+# Fetch from a specific scale table
+# Use get_body_composition_measurements() for scales with impedance sensors
+# (body fat, muscle, etc.) — the server-side count is unreliable for these.
+# Fall back to get_measurements() for weight-only scales.
+table = scales[0]
+measurements = client.get_body_composition_measurements(
+    table_name=table["tableName"],
+    user_id=client.user_id,
+)
+if not measurements:
+    measurements = client.get_measurements(
+        table_name=table["tableName"],
+        user_id=client.user_id,
+        total_count=table["count"],
+    )
+
+# Export
+save_json(measurements, "my_data.json")
+save_csv(measurements, "my_data.csv")
+```
+
+### Multiple Renpho accounts on one email
+
+Some users end up with **two Renpho accounts under the same email** — for
+example after the Google SSO migration created an orphan account, or after
+re-registering. Each account has its own user ID and its own measurement
+table, so the default `get_all_measurements()` will only return data from
+the account you log in to.
+
+If you know the other account's user ID, pass it in:
+
+```python
+measurements = client.get_all_measurements(
+    extra_user_ids=["5975813831868809088"],
+)
+```
+
+The library will probe every measurement table for that user ID, fetch
+matching records, and dedupe by record `id` so you get a single combined
+timeline.
+
+**How to find your other user ID:**
+
+Unfortunately there is no first-party API endpoint that lists "all
+accounts associated with this email" — Renpho treats accounts as
+independent even when emails collide. Options:
+
+1. **Renpho support** — email them and ask for your user ID(s) on file
+2. **Inspect the iOS / Android app** — sign in to the other account in
+   the official app and look in Settings / Account / Help → Feedback
+   pages (the user ID is sometimes visible there)
+3. **Capture network traffic** — proxy the official app through
+   mitmproxy, sign in, and look at any request body containing
+   `userId` (decrypt with the published AES-128 key — see the
+   reverse-engineering write-up linked at the top of this README)
+
+Once you have the ID, save it alongside your credentials and you won't
+need to discover it again.
+
+### Error handling
+
+```python
+from renpho import RenphoClient, RenphoAPIError
+
+client = RenphoClient("user@example.com", "wrong_password")
+try:
+    client.login()
+except RenphoAPIError as e:
+    print(f"API error: {e}")
+```
+
+## Available Metrics
+
+Each measurement dict can contain these fields (availability depends on your scale model):
+
+| Key | Description | Unit |
+| --- | --- | --- |
+| `weight` | Weight | kg |
+| `bmi` | BMI | |
+| `bodyfat` | Body Fat | % |
+| `water` | Body Water | % |
+| `muscle` | Muscle Mass | % |
+| `bone` | Bone Mass | % |
+| `bmr` | Basal Metabolic Rate | kcal/day |
+| `visfat` | Visceral Fat | level |
+| `subfat` | Subcutaneous Fat | % |
+| `protein` | Protein | % |
+| `bodyage` | Body Age | years |
+| `sinew` | Lean Body Mass | kg |
+| `fatFreeWeight` | Fat Free Weight | kg |
+| `heartRate` | Heart Rate | bpm |
+| `cardiacIndex` | Cardiac Index | |
+| `bodyShape` | Body Shape | |
+
+## Project Structure
+
+```
+renpho-py/
+├── pyproject.toml        # Package config & dependencies (dist name: renpho-py)
+├── README.md
+├── CHANGELOG.md
+├── LICENSE               # MIT (original + current attribution)
+├── NOTICE
+├── renpho/               # import name — unchanged for drop-in migration
+│   ├── __init__.py       # Public API exports
+│   ├── py.typed          # PEP 561 typing marker
+│   ├── client.py         # RenphoClient class
+│   ├── cli.py            # CLI entry point
+│   ├── constants.py      # API endpoints, device types, metrics
+│   ├── crypto.py         # AES encryption/decryption
+│   └── export.py         # JSON/CSV export helpers
+├── tests/                # Unit tests
+└── .github/workflows/    # CI + PyPI release automation (trusted publishing)
+```

renpho_py-1.0.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "renpho-py"
+version = "1.0.0"
+description = "Unofficial Renpho Health API client for Python — pull body composition data from Renpho smart scales."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.10"
+authors = [{ name = "ChocoTonic" }]
+maintainers = [{ name = "ChocoTonic" }]
+keywords = [
+    "renpho",
+    "renpho-api",
+    "health",
+    "body-composition",
+    "smart-scale",
+    "api-client",
+    "python",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+dependencies = [
+    "requests>=2.28",
+    "pycryptodome>=3.15",
+]
+
+[project.optional-dependencies]
+dotenv = ["python-dotenv>=1.0"]
+dev = ["pytest>=7.0"]
+
+[project.urls]
+Homepage = "https://github.com/ChocoTonic/renpho-py"
+Repository = "https://github.com/ChocoTonic/renpho-py"
+Issues = "https://github.com/ChocoTonic/renpho-py/issues"
+Changelog = "https://github.com/ChocoTonic/renpho-py/blob/main/CHANGELOG.md"
+
+[project.scripts]
+renpho = "renpho.cli:main"
+
+[tool.setuptools]
+packages = ["renpho"]
+
+[tool.setuptools.package-data]
+renpho = ["py.typed"]
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=7.1.0",
+]

renpho_py-1.0.0/renpho/__init__.py

@@ -0,0 +1,24 @@
+"""renpho - Unofficial Python client for the Renpho Health API.
+
+Pull body composition measurements from Renpho smart scales.
+
+Quick start::
+
+    from renpho import RenphoClient
+
+    client = RenphoClient("user@example.com", "password")
+    client.login()
+    measurements = client.get_all_measurements()
+"""
+
+from .client import RenphoAPIError, RenphoClient
+from .export import format_measurement, format_timestamp, save_csv, save_json
+
+__all__ = [
+    "RenphoClient",
+    "RenphoAPIError",
+    "format_measurement",
+    "format_timestamp",
+    "save_csv",
+    "save_json",
+]

renpho_py-1.0.0/renpho/cli.py

@@ -0,0 +1,111 @@
+"""Command-line interface for pulling Renpho scale data."""
+
+import os
+import sys
+from pathlib import Path
+
+try:
+    from dotenv import load_dotenv
+
+    load_dotenv()
+except ImportError:
+    pass
+
+from .client import RenphoClient
+from .export import format_measurement, save_csv, save_json
+
+
+def main(argv: list[str] | None = None) -> None:
+    """Entry point for the ``renpho`` CLI command."""
+    email = os.getenv("RENPHO_EMAIL", "")
+    password = os.getenv("RENPHO_PASSWORD", "")
+    debug = os.getenv("RENPHO_DEBUG", "").lower() in ("1", "true", "yes")
+    output_dir = Path(os.getenv("RENPHO_OUTPUT_DIR", "renpho_data"))
+
+    if not email or not password:
+        print("Missing credentials!\n")
+        print("Create a .env file with:")
+        print("  RENPHO_EMAIL=your@email.com")
+        print("  RENPHO_PASSWORD=your_plain_text_password")
+        print("  RENPHO_DEBUG=1  # optional")
+        sys.exit(1)
+
+    client = RenphoClient(email, password, debug=debug)
+
+    # Step 1: Login
+    print(f"Logging in as {email}...")
+    client.login()
+    print(f"Logged in! User ID: {client.user_id}")
+
+    # Step 2: Device info
+    print("Getting device info...")
+    device_info = client.get_device_info()
+
+    if not device_info:
+        print("Could not get device info")
+        sys.exit(1)
+
+    save_json(device_info, output_dir / "device_info.json")
+
+    scales = device_info.get("scale", [])
+    if not scales:
+        print("No scales found in device info")
+        print(f"  Device info keys: {list(device_info.keys())}")
+        sys.exit(1)
+
+    print(f"\nFound {len(scales)} scale table(s):")
+    for i, scale in enumerate(scales):
+        table = scale.get("tableName", "unknown")
+        count = scale.get("count", 0)
+        uids = scale.get("userIds", [])
+        print(f"  [{i}] table={table}, records={count}, users={uids}")
+
+    # Step 3: Fetch measurements
+    all_measurements: list[dict] = []
+    for scale in scales:
+        table_name = scale.get("tableName")
+        count = scale.get("count", 0)
+        user_ids = scale.get("userIds", [])
+
+        if not table_name or count == 0:
+            continue
+
+        uid = client.user_id
+        if user_ids and uid not in user_ids:
+            uid = user_ids[0]
+
+        print(f"Fetching measurements (table: {table_name}, total: {count})...")
+        measurements = client.get_measurements(table_name, uid, count)
+        all_measurements.extend(measurements)
+
+    if not all_measurements:
+        print("\nNo measurements found.")
+        print("  Try setting RENPHO_DEBUG=1 to see API responses.")
+        return
+
+    # Sort newest first
+    all_measurements.sort(
+        key=lambda m: m.get("timeStamp", 0) or 0,
+        reverse=True,
+    )
+
+    print(f"\nTotal: {len(all_measurements)} measurement(s)")
+
+    # Display most recent 5
+    for i, m in enumerate(all_measurements[:5]):
+        print(f"\n{'=' * 55}")
+        print(f"  Measurement #{i + 1}")
+        print(f"{'=' * 55}")
+        print(format_measurement(m))
+
+    if len(all_measurements) > 5:
+        print(f"\n  ... and {len(all_measurements) - 5} more")
+
+    # Save data
+    save_json(all_measurements, output_dir / "measurements.json")
+    save_csv(all_measurements, output_dir / "measurements.csv")
+
+    if client.user_info:
+        save_json(client.user_info, output_dir / "user_profile.json")
+
+    print(f"\nDone! Data saved to '{output_dir}/' folder.")