vitallens-core 0.2.2__tar.gz

vitallens_core-0.2.2/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  core-and-web-linux:
+    name: Linux Checks (Core, Python, Web)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Run Core Tests
+        run: make test
+
+      - name: Check Python Bindings
+        run: make check-python
+
+      - name: Check WebAssembly
+        run: make check-web
+
+  apple-macos:
+    name: Apple Checks (iOS, macOS)
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: aarch64-apple-ios, aarch64-apple-ios-sim, x86_64-apple-ios, aarch64-apple-darwin, x86_64-apple-darwin
+
+      - name: Check Apple Bindings
+        run: make check-apple

vitallens_core-0.2.2/.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: Publish NPM and PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  npm-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+      - uses: jetli/wasm-pack-action@v0.4.0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Build and Publish
+        run: |
+          wasm-pack build --target web --no-default-features
+          cd pkg
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  python-release:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            args: --release --out dist --features python --sdist
+          - os: macos-latest
+            args: --release --out dist --features python --target universal2-apple-darwin
+          - os: windows-latest
+            args: --release --out dist --features python
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install macOS Rust Targets
+        if: matrix.os == 'macos-latest'
+        run: rustup target add x86_64-apple-darwin aarch64-apple-darwin
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: ${{ matrix.args }}
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: dist
+
+  publish-pypi:
+    needs: python-release
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

vitallens_core-0.2.2/.gitignore

@@ -0,0 +1,34 @@
+# Rust
+/target
+**/*.rs.bk
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+.venv/
+venv/
+*.egg-info/
+.pytest_cache/
+
+# Maturin / PyO3 artifacts
+*.so
+*.dylib
+*.dll
+
+# Web / Wasm
+pkg/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Mac
+.DS_Store
+
+# Bindings
+/bindings/headers/
+/bindings/swift/VitalLensCoreFFI.h
+/bindings/swift/VitalLensCoreFFI.modulemap

vitallens_core-0.2.2/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing & Development Guide
+
+This guide covers setting up the development environment, running tests, and building targets for **vitallens-core**.
+
+## Environment Setup
+
+You need the following toolchains installed (assuming macOS):
+
+**1. Rust & Cargo**
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+rustup default stable
+```
+
+**2. Python (Virtual Env & Maturin)**
+
+```bash
+brew install python@3.10
+pip3 install maturin
+```
+
+**3. WebAssembly (wasm-pack)**
+
+```bash
+curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+```
+
+**4. Apple Targets & Tools**
+
+Ensure Xcode Command Line Tools are installed (required for `lipo` and `xcodebuild`). Add the Rust compilation targets:
+
+```bash
+rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios aarch64-apple-darwin x86_64-apple-darwin
+```
+
+## Build & Test Commands
+
+We use a `Makefile` to automate tasks.
+
+| Command | Description |
+| --- | --- |
+| `make check` | Runs syntax checks across all targets and standard Rust unit tests. Fast. |
+| `make build` | Runs full, optimized release builds for Python, Apple, and Web. |
+| `make test` | Runs standard Rust unit tests (`cargo test`). |
+| `make check-<target>` | Runs `cargo check` for `<target>` (`python`, `apple`, `web`). |
+| `make build-<target>` | Compiles release artifacts for `<target>`. |
+| `make clean` | Removes build artifacts (`target/`, `pkg/`, `bindings/swift/`). |
+
+## Detailed Workflows
+
+### Core Rust Logic
+
+To run unit tests manually:
+
+```bash
+cargo test
+cargo test -- --nocapture # Show print statements
+cargo test --test session_tests # Run specific test suite
+cargo test test_logic_irregular_rhythm # Test specific function
+```
+
+### Python Bindings (PyO3 + Maturin)
+
+To test Python bindings locally without building a release wheel:
+
+```bash
+maturin develop --features python
+```
+
+This builds and installs the extension directly into your active virtual environment.
+
+### Apple Bindings (UniFFI)
+
+Running `make build-apple` handles compiling for physical devices, Intel/Apple Silicon simulators, merging binaries via `lipo`, generating Swift headers, and packaging the final XCFramework.
+
+### Web Bindings (Wasm)
+
+Running `make build-web` compiles the Wasm binary and generates JS/TS glue code into the `pkg/` directory.
+
+## Release Workflow
+
+We use GitHub Actions to automate publishing to npm and PyPI. The Apple XCFramework must be built and attached locally to ensure SPM checksums match the git tag.
+
+1. **Pull Latest:** Ensure your local `main` branch is up to date.
+
+```bash
+git checkout main
+git pull origin main
+```
+
+2. **Bump & Build:** Run the appropriate version command. This automatically bumps `Cargo.toml`, builds the Apple framework, updates `Package.swift`, commits the changes, and tags the release.
+
+```bash
+make version-patch # or version-minor, version-major
+```
+
+3. **Push:** Push the version commit and the new tag.
+
+```bash
+git push origin main --follow-tags
+```
+
+4. **Publish Release:** Create the GitHub release and upload the local XCFramework zip. (The `make` command will output the exact command for you to copy-paste).
+
+```bash
+gh release create vX.Y.Z target/VitalLensCoreFFI.xcframework.zip --generate-notes
+```
+
+Once the release is published, CI will automatically build and publish the cross-platform Python wheels to PyPI and the WebAssembly package to npm.