linc-device-kit 1.0.0__tar.gz

linc_device_kit-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,16 @@
+name: release
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

linc_device_kit-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: test
+on:
+  push: {branches: [main]}
+  pull_request:
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python: ["3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv python install ${{ matrix.python }}
+      - run: uv sync --all-extras --python ${{ matrix.python }}
+      - run: uv run pytest -q

linc_device_kit-1.0.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to linc-device-kit are listed here.
+
+## [1.0.0]
+
+First public release.
+
+- Models: `DeviceInfo`, `Rect`, `ElementNode` (compact `to_dict` / `from_dict`), `ScreenState`
+  (`from_dict`, computed `element_count`); `Platform`, `DeviceType`, `SemanticRole` enums.
+- `IDeviceIO` runtime-checkable protocol and the `DeviceKitError` exception hierarchy.
+- Licence: Apache-2.0.

linc_device_kit-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+Issues are welcome — bug reports with a minimal snippet that reproduces the problem and your Python version help most.
+
+This repository is a **release mirror**: development happens in LINC's private repository and each
+release lands here as one commit. Pull requests are accepted **by arrangement** — open an issue
+first. If we take your change, we apply it upstream with your authorship credited
+(`Co-authored-by`) and it ships in the next release.
+
+All contributions require a Developer Certificate of Origin sign-off: add
+`Signed-off-by: Your Name <you@example.com>` to each commit (`git commit -s`).
+See https://developercertificate.org/.

linc_device_kit-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

linc_device_kit-1.0.0/NOTICE

@@ -0,0 +1,2 @@
+LINC Device Kit
+Copyright 2026 LINC Innovations LLC

linc_device_kit-1.0.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.5
+Name: linc-device-kit
+Version: 1.0.0
+Summary: Shared device models and protocols for LINC tools
+Project-URL: Homepage, https://github.com/LincForge/device-kit
+Project-URL: Issues, https://github.com/LincForge/device-kit/issues
+Author: LINC Innovations
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# linc-device-kit
+
+Plain data types for tools that drive Android and iOS devices: an accessibility-tree node, a
+screen snapshot, device identity, and the `IDeviceIO` protocol a device adapter implements.
+Pure dataclasses with no I/O and no dependencies, so an MCP server, a test harness and a
+quality checker can share one vocabulary and one compact JSON shape.
+[nerve](https://github.com/LincForge/nerve) uses it.
+
+## Install
+
+```bash
+pip install linc-device-kit        # or: uv add linc-device-kit
+```
+
+Python 3.12+. No runtime dependencies.
+
+## Example
+
+```python
+import json
+
+from linc_device_kit import (
+    DeviceInfo, DeviceType, ElementNode, Platform, Rect, ScreenState, SemanticRole,
+)
+
+login = ElementNode(
+    id="login", text="Sign in", role=SemanticRole.BUTTON,
+    bounds=Rect(x=40, y=900, width=400, height=96), clickable=True,
+)
+root = ElementNode(role=SemanticRole.CONTAINER, children=[login])
+state = ScreenState(
+    device=DeviceInfo("emulator-5554", Platform.ANDROID, DeviceType.EMULATOR),
+    timestamp="2026-10-01T12:00:00Z",
+    elements=root,
+    foreground_app="com.example.app",
+)
+
+payload = state.to_dict()  # compact: fields at their defaults are omitted
+print(json.dumps(payload["elements"]))
+print(payload["element_count"])
+assert ScreenState.from_dict(payload) == state
+```
+
+```console
+$ python example.py
+{"role": "container", "children": [{"id": "login", "text": "Sign in", "role": "button", "bounds": {"x": 40, "y": 900, "width": 400, "height": 96}, "clickable": true}]}
+2
+```
+
+`ElementNode.to_dict()` leaves out every field that is at its default, which keeps an
+accessibility tree small enough to hand to an AI agent. `from_dict` restores the defaults, so
+`from_dict(to_dict(x)) == x`. `ScreenState.to_dict()` never includes the screenshot bytes.
+
+## What is in it
+
+| Type | What it holds |
+|------|---------------|
+| `ElementNode` | One accessibility-tree node: id, text, description, value, role, bounds, clickable/enabled/focused/scrollable/checked, children |
+| `ScreenState` | A screen at a point in time: device, ISO 8601 timestamp, element tree, optional screenshot bytes, foreground app, screen name; `element_count` is computed from the tree |
+| `DeviceInfo` | Serial, platform, device type, model, OS version |
+| `Rect` | Axis-aligned bounds: x, y, width, height |
+| `Platform`, `DeviceType`, `SemanticRole` | `StrEnum`s, so they serialise as plain strings |
+| `IDeviceIO` | `@runtime_checkable` protocol: screenshot, elements, foreground_app, logs, tap, swipe, type_text, press_key, install, launch, kill, clear_app_data, grant_permission, forward_debug_port, list_debug_targets, capabilities |
+| `DeviceKitError` | Base of the exception hierarchy (`DeviceNotReachable`, `DeviceNotConfigured`, `InstallFailed`, `BuildFailed`, `SigningError`, `WDAStartupFailed`, `QualityGateFailed`) |
+
+## Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+```
+
+## How this repo works
+
+This is a release mirror of a private LINC repository. The code is built by LINC's AI software
+factory under human review, and each release lands here as one commit. Issues are welcome; see
+[CONTRIBUTING.md](CONTRIBUTING.md). To report a security problem, see [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+---
+
+Built by [LINC Innovations](https://lincinnovations.com/audit?utm_source=github&utm_medium=readme&utm_campaign=device-kit). We diagnose flaky device test suites.

linc_device_kit-1.0.0/README.md

@@ -0,0 +1,85 @@
+# linc-device-kit
+
+Plain data types for tools that drive Android and iOS devices: an accessibility-tree node, a
+screen snapshot, device identity, and the `IDeviceIO` protocol a device adapter implements.
+Pure dataclasses with no I/O and no dependencies, so an MCP server, a test harness and a
+quality checker can share one vocabulary and one compact JSON shape.
+[nerve](https://github.com/LincForge/nerve) uses it.
+
+## Install
+
+```bash
+pip install linc-device-kit        # or: uv add linc-device-kit
+```
+
+Python 3.12+. No runtime dependencies.
+
+## Example
+
+```python
+import json
+
+from linc_device_kit import (
+    DeviceInfo, DeviceType, ElementNode, Platform, Rect, ScreenState, SemanticRole,
+)
+
+login = ElementNode(
+    id="login", text="Sign in", role=SemanticRole.BUTTON,
+    bounds=Rect(x=40, y=900, width=400, height=96), clickable=True,
+)
+root = ElementNode(role=SemanticRole.CONTAINER, children=[login])
+state = ScreenState(
+    device=DeviceInfo("emulator-5554", Platform.ANDROID, DeviceType.EMULATOR),
+    timestamp="2026-10-01T12:00:00Z",
+    elements=root,
+    foreground_app="com.example.app",
+)
+
+payload = state.to_dict()  # compact: fields at their defaults are omitted
+print(json.dumps(payload["elements"]))
+print(payload["element_count"])
+assert ScreenState.from_dict(payload) == state
+```
+
+```console
+$ python example.py
+{"role": "container", "children": [{"id": "login", "text": "Sign in", "role": "button", "bounds": {"x": 40, "y": 900, "width": 400, "height": 96}, "clickable": true}]}
+2
+```
+
+`ElementNode.to_dict()` leaves out every field that is at its default, which keeps an
+accessibility tree small enough to hand to an AI agent. `from_dict` restores the defaults, so
+`from_dict(to_dict(x)) == x`. `ScreenState.to_dict()` never includes the screenshot bytes.
+
+## What is in it
+
+| Type | What it holds |
+|------|---------------|
+| `ElementNode` | One accessibility-tree node: id, text, description, value, role, bounds, clickable/enabled/focused/scrollable/checked, children |
+| `ScreenState` | A screen at a point in time: device, ISO 8601 timestamp, element tree, optional screenshot bytes, foreground app, screen name; `element_count` is computed from the tree |
+| `DeviceInfo` | Serial, platform, device type, model, OS version |
+| `Rect` | Axis-aligned bounds: x, y, width, height |
+| `Platform`, `DeviceType`, `SemanticRole` | `StrEnum`s, so they serialise as plain strings |
+| `IDeviceIO` | `@runtime_checkable` protocol: screenshot, elements, foreground_app, logs, tap, swipe, type_text, press_key, install, launch, kill, clear_app_data, grant_permission, forward_debug_port, list_debug_targets, capabilities |
+| `DeviceKitError` | Base of the exception hierarchy (`DeviceNotReachable`, `DeviceNotConfigured`, `InstallFailed`, `BuildFailed`, `SigningError`, `WDAStartupFailed`, `QualityGateFailed`) |
+
+## Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+```
+
+## How this repo works
+
+This is a release mirror of a private LINC repository. The code is built by LINC's AI software
+factory under human review, and each release lands here as one commit. Issues are welcome; see
+[CONTRIBUTING.md](CONTRIBUTING.md). To report a security problem, see [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+---
+
+Built by [LINC Innovations](https://lincinnovations.com/audit?utm_source=github&utm_medium=readme&utm_campaign=device-kit). We diagnose flaky device test suites.

linc_device_kit-1.0.0/SECURITY.md

@@ -0,0 +1,14 @@
+# Security
+
+## Report a vulnerability
+
+Use GitHub's **private vulnerability reporting** on this repository (Security → Report a
+vulnerability). Please do not open a public issue for security problems. We aim to
+acknowledge within 3 business days.
+
+## Threat model in one paragraph
+
+linc-device-kit is pure data: dataclasses, enums, a `Protocol` and exception types. It does
+no I/O, starts no subprocess and opens no network connection. The `from_dict` constructors
+trust the shape of their input, so validate untrusted payloads before you build models from
+them.

linc_device_kit-1.0.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "linc-device-kit"
+version = "1.0.0"
+description = "Shared device models and protocols for LINC tools"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+authors = [
+    { name = "LINC Innovations" },
+]
+readme = "README.md"
+
+[project.urls]
+Homepage = "https://github.com/LincForge/device-kit"
+Issues = "https://github.com/LincForge/device-kit/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.9",
+]
+
+[build-system]
+requires = [
+    "hatchling>=1.27",
+]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/linc_device_kit",
+]
+
+[tool.ruff]
+line-length = 99
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+    "RUF",
+    "ANN",
+]
+ignore = [
+    "ANN401",
+]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]

linc_device_kit-1.0.0/src/linc_device_kit/__init__.py

@@ -0,0 +1,41 @@
+"""linc-device-kit — shared device models and protocols for LINC tools."""
+
+from linc_device_kit.exceptions import (
+    BuildFailed,
+    DeviceKitError,
+    DeviceNotConfigured,
+    DeviceNotReachable,
+    InstallFailed,
+    QualityGateFailed,
+    SigningError,
+    WDAStartupFailed,
+)
+from linc_device_kit.models import (
+    DeviceInfo,
+    DeviceType,
+    ElementNode,
+    Platform,
+    Rect,
+    ScreenState,
+    SemanticRole,
+)
+from linc_device_kit.protocol import IDeviceIO
+
+__all__ = [
+    "BuildFailed",
+    "DeviceInfo",
+    "DeviceKitError",
+    "DeviceNotConfigured",
+    "DeviceNotReachable",
+    "DeviceType",
+    "ElementNode",
+    "IDeviceIO",
+    "InstallFailed",
+    "Platform",
+    "QualityGateFailed",
+    "Rect",
+    "ScreenState",
+    "SemanticRole",
+    "SigningError",
+    "WDAStartupFailed",
+]

linc_device_kit-1.0.0/src/linc_device_kit/exceptions.py

@@ -0,0 +1,36 @@
+"""Typed failure taxonomy for LINC device operations.
+
+No I/O — these are pure exception class definitions.
+"""
+
+
+class DeviceKitError(Exception):
+    """Base exception for all linc-device-kit errors."""
+
+
+class DeviceNotReachable(DeviceKitError):
+    """Device is not connected or not responding."""
+
+
+class DeviceNotConfigured(DeviceKitError):
+    """Device exists but lacks required configuration."""
+
+
+class BuildFailed(DeviceKitError):
+    """Project build step failed."""
+
+
+class InstallFailed(DeviceKitError):
+    """App installation onto device failed."""
+
+
+class QualityGateFailed(DeviceKitError):
+    """Quality gate (lint, test, score) did not pass."""
+
+
+class WDAStartupFailed(DeviceKitError):
+    """WebDriverAgent failed to start on iOS device."""
+
+
+class SigningError(DeviceKitError):
+    """Code signing or provisioning profile error."""