benchci 0.1.0__tar.gz

benchci-0.1.0/LICENSE

@@ -0,0 +1,60 @@
+# BenchCI License
+
+Copyright (c) 2026 BenchCI
+
+All rights reserved.
+
+---
+
+# License Terms
+
+BenchCI is proprietary software.
+
+Permission to use BenchCI is granted only to licensed users under the terms of a commercial agreement.
+
+This license governs the use of the BenchCI software distributed by BenchCI.
+
+---
+
+# Permitted Use
+
+Licensed users may:
+
+- install BenchCI within their organization
+- run BenchCI on development machines or CI environments
+- integrate BenchCI into internal workflows
+- use BenchCI for firmware validation and testing
+
+---
+
+# Restrictions
+
+Users may NOT:
+
+- redistribute BenchCI software
+- publish BenchCI binaries
+- sublicense BenchCI
+- reverse engineer the software for redistribution
+- remove licensing or copyright notices
+
+---
+
+# Ownership
+
+BenchCI and all associated intellectual property remain the exclusive property of BenchCI.
+
+---
+
+# Warranty
+
+BenchCI is provided "as is" without warranty of any kind.
+
+BenchCI shall not be liable for damages arising from the use of the software.
+
+---
+
+# Contact
+
+Licensing inquiries:
+
+tech@benchci.dev

benchci-0.1.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: benchci
+Version: 0.1.0
+Summary: Continuous Integration for Embedded Hardware
+Author: BenchCI
+License-Expression: LicenseRef-Proprietary
+Project-URL: Homepage, https://benchci.dev
+Project-URL: Documentation, https://docs.benchci.dev
+Project-URL: Source, https://github.com/BenchCI/BenchCI
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Embedded Systems
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12
+Requires-Dist: pyserial>=3.5
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: pydantic>=2.6
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn>=0.27
+Requires-Dist: httpx>=0.27
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: pymodbus>=3.6
+Requires-Dist: python-can>=4.0
+Requires-Dist: gpiod; platform_system == "Linux"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
+Dynamic: license-file
+
+# BenchCI
+
+[![Documentation](https://img.shields.io/badge/docs-available-blue)](https://docs.benchci.dev)
+[![Early Access](https://img.shields.io/badge/status-early--access-orange)](mailto:tech@benchci.dev)
+![Hardware CI](https://img.shields.io/badge/focus-hardware%20CI-success)
+![Embedded](https://img.shields.io/badge/target-embedded%20systems-blueviolet)
+[![License](https://img.shields.io/badge/license-commercial-lightgrey)]()
+
+> **Run hardware-in-the-loop tests on real embedded devices — locally or in CI.**
+
+BenchCI is a lightweight test runner for embedded systems that lets you define hardware tests declaratively and execute them against real devices using UART, Modbus, and GPIO.
+
+---
+
+## ⚡ Why BenchCI?
+
+Testing embedded firmware usually looks like this:
+
+* Flash firmware manually
+* Open serial terminal
+* Send commands
+* Watch logs
+* Write ad-hoc scripts
+* Repeat for every release
+
+👉 This does **not scale**.
+
+BenchCI turns this into a **repeatable, automated, CI-ready workflow**.
+
+---
+
+## 🧠 What BenchCI Does
+
+BenchCI connects your CI pipeline directly to real hardware and allows you to:
+
+* Flash firmware automatically
+* Interact with devices over UART, Modbus RTU/TCP
+* Control and monitor GPIO lines
+* Validate behavior with structured test steps
+* Generate reproducible test artifacts
+
+---
+
+## 🏗️ How It Works
+
+```
+CI Pipeline / Developer
+        │
+        ▼
+   benchci run
+        │
+        ▼
+   BenchCI Agent
+        │
+        ▼
+   Hardware Device
+```
+
+---
+
+## 🧰 CLI Workflow
+
+BenchCI provides built-in tools to help you validate your setup:
+
+- `benchci doctor` — check system dependencies  
+- `benchci validate` — validate configuration files  
+- `benchci login` — authenticate with BenchCI services  
+
+These commands help ensure reliable execution before running tests.
+
+---
+
+## 🚀 Example (30 seconds)
+
+Define your test suite:
+
+```yaml
+name: firmware_tests
+
+tests:
+
+  - name: boot_ok
+    steps:
+      - expect_uart:
+          contains: "[BOOT] OK"
+          within_ms: 3000
+
+  - name: ping
+    steps:
+      - send_uart: "PING\n"
+      - expect_uart:
+          contains: "PONG"
+          within_ms: 1000
+```
+
+Run it:
+
+```
+benchci run -b board.yaml -s suite.yaml -a build/fw.elf
+```
+
+BenchCI will:
+
+* flash firmware
+* reset the device
+* execute tests
+* validate responses
+* store logs and results
+
+---
+
+## 🔌 Supported Interfaces
+
+BenchCI is designed for real hardware interaction:
+
+* UART communication
+* Modbus RTU
+* Modbus TCP
+* Linux GPIO (input, output, edge detection)
+
+---
+
+## 📦 Output Artifacts
+
+Each run produces structured results:
+
+```
+benchci-results/
+├── transport.log
+├── flash.log
+├── gpio.log
+└── results.json
+```
+
+Perfect for CI pipelines and debugging.
+
+---
+
+## 🔄 CI Integration
+
+BenchCI is built for automation:
+
+* GitLab CI support (example included)
+* Works with any CI runner connected to hardware
+* Agent-based execution for remote benches
+
+See: `examples/ci/gitlab`
+
+---
+
+## 📚 Documentation
+
+Full documentation:
+
+👉 https://docs.benchci.dev
+
+Key topics:
+
+* Quickstart
+* Installation
+* Board configuration
+* Test suite definition
+* CI integration
+* Architecture
+
+---
+
+## 📌 Repository Contents
+
+This repository contains:
+
+* documentation
+* configuration examples
+* CI integration examples
+* helper tools
+
+BenchCI source code is maintained in a private repository.
+
+---
+
+## 💼 License
+
+BenchCI is a commercial product.
+
+To request access:
+
+📧 [tech@benchci.dev](mailto:tech@benchci.dev)

benchci-0.1.0/README.md

@@ -0,0 +1,187 @@
+# BenchCI
+
+[![Documentation](https://img.shields.io/badge/docs-available-blue)](https://docs.benchci.dev)
+[![Early Access](https://img.shields.io/badge/status-early--access-orange)](mailto:tech@benchci.dev)
+![Hardware CI](https://img.shields.io/badge/focus-hardware%20CI-success)
+![Embedded](https://img.shields.io/badge/target-embedded%20systems-blueviolet)
+[![License](https://img.shields.io/badge/license-commercial-lightgrey)]()
+
+> **Run hardware-in-the-loop tests on real embedded devices — locally or in CI.**
+
+BenchCI is a lightweight test runner for embedded systems that lets you define hardware tests declaratively and execute them against real devices using UART, Modbus, and GPIO.
+
+---
+
+## ⚡ Why BenchCI?
+
+Testing embedded firmware usually looks like this:
+
+* Flash firmware manually
+* Open serial terminal
+* Send commands
+* Watch logs
+* Write ad-hoc scripts
+* Repeat for every release
+
+👉 This does **not scale**.
+
+BenchCI turns this into a **repeatable, automated, CI-ready workflow**.
+
+---
+
+## 🧠 What BenchCI Does
+
+BenchCI connects your CI pipeline directly to real hardware and allows you to:
+
+* Flash firmware automatically
+* Interact with devices over UART, Modbus RTU/TCP
+* Control and monitor GPIO lines
+* Validate behavior with structured test steps
+* Generate reproducible test artifacts
+
+---
+
+## 🏗️ How It Works
+
+```
+CI Pipeline / Developer
+        │
+        ▼
+   benchci run
+        │
+        ▼
+   BenchCI Agent
+        │
+        ▼
+   Hardware Device
+```
+
+---
+
+## 🧰 CLI Workflow
+
+BenchCI provides built-in tools to help you validate your setup:
+
+- `benchci doctor` — check system dependencies  
+- `benchci validate` — validate configuration files  
+- `benchci login` — authenticate with BenchCI services  
+
+These commands help ensure reliable execution before running tests.
+
+---
+
+## 🚀 Example (30 seconds)
+
+Define your test suite:
+
+```yaml
+name: firmware_tests
+
+tests:
+
+  - name: boot_ok
+    steps:
+      - expect_uart:
+          contains: "[BOOT] OK"
+          within_ms: 3000
+
+  - name: ping
+    steps:
+      - send_uart: "PING\n"
+      - expect_uart:
+          contains: "PONG"
+          within_ms: 1000
+```
+
+Run it:
+
+```
+benchci run -b board.yaml -s suite.yaml -a build/fw.elf
+```
+
+BenchCI will:
+
+* flash firmware
+* reset the device
+* execute tests
+* validate responses
+* store logs and results
+
+---
+
+## 🔌 Supported Interfaces
+
+BenchCI is designed for real hardware interaction:
+
+* UART communication
+* Modbus RTU
+* Modbus TCP
+* Linux GPIO (input, output, edge detection)
+
+---
+
+## 📦 Output Artifacts
+
+Each run produces structured results:
+
+```
+benchci-results/
+├── transport.log
+├── flash.log
+├── gpio.log
+└── results.json
+```
+
+Perfect for CI pipelines and debugging.
+
+---
+
+## 🔄 CI Integration
+
+BenchCI is built for automation:
+
+* GitLab CI support (example included)
+* Works with any CI runner connected to hardware
+* Agent-based execution for remote benches
+
+See: `examples/ci/gitlab`
+
+---
+
+## 📚 Documentation
+
+Full documentation:
+
+👉 https://docs.benchci.dev
+
+Key topics:
+
+* Quickstart
+* Installation
+* Board configuration
+* Test suite definition
+* CI integration
+* Architecture
+
+---
+
+## 📌 Repository Contents
+
+This repository contains:
+
+* documentation
+* configuration examples
+* CI integration examples
+* helper tools
+
+BenchCI source code is maintained in a private repository.
+
+---
+
+## 💼 License
+
+BenchCI is a commercial product.
+
+To request access:
+
+📧 [tech@benchci.dev](mailto:tech@benchci.dev)

benchci-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "benchci"
+dynamic = ["version"]
+description = "Continuous Integration for Embedded Hardware"
+authors = [
+    { name = "BenchCI" }
+]
+readme = "README.md"
+requires-python = ">=3.11"
+license = "LicenseRef-Proprietary"
+license-files = ["LICENSE"]
+dependencies = [
+    "typer>=0.12",
+    "pyserial>=3.5",
+    "pyyaml>=6.0",
+    "pydantic>=2.6",
+    "fastapi>=0.110",
+    "uvicorn>=0.27",
+    "httpx>=0.27",
+    "python-multipart>=0.0.9",
+    "pymodbus>=3.6",
+    "python-can>=4.0",
+    'gpiod; platform_system == "Linux"',
+]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Embedded Systems",
+]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx>=7",
+    "furo",
+    "myst-parser",
+    "sphinxcontrib-mermaid",
+]
+
+[project.urls]
+Homepage = "https://benchci.dev"
+Documentation = "https://docs.benchci.dev"
+Source = "https://github.com/BenchCI/BenchCI"
+
+[project.scripts]
+benchci = "benchci.cli:app"
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = { attr = "benchci.__version__" }
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

benchci-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

benchci-0.1.0/src/benchci/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"