assay-kit 0.1.0__tar.gz

assay_kit-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: assay-kit
+Version: 0.1.0
+Summary: Independent verification layer for software projects
+Author: Shaznay Sison
+License: MIT
+Keywords: testing,verification,playwright,automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: apscheduler>=3.10
+Requires-Dist: bcrypt>=4.1
+Requires-Dist: fastapi>=0.111
+Requires-Dist: jsonschema>=4.23
+Requires-Dist: typer>=0.12
+Requires-Dist: uvicorn>=0.29
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+# Assay
+
+Independent verification layer for software projects. Assay runs Playwright-based browser tests in Docker, captures screenshots and results, formats them as structured task packets, and delivers them to a Grain workflow via the ingest API.
+
+## Requirements
+
+- Python 3.11+
+- Docker (for `assay run`)
+- Node.js 18+ (for the TypeScript browser SDK)
+
+## Install
+
+```bash
+pip install assay-kit
+```
+
+Or from source:
+
+```bash
+git clone <repo>
+cd assay
+pip install -e .
+```
+
+## Quick Start
+
+### 1. Configure
+
+Create `assay.toml` in your project root (all fields optional — defaults shown):
+
+```toml
+[project]
+name = "my-project"
+
+[runner]
+docker_image = "assay-playwright:latest"
+timeout_seconds = 300
+
+[output]
+directory = "./assay-output"
+
+[serve]
+host = "127.0.0.1"
+port = 8000
+
+[keys]
+store = "~/.assay/keys.json"
+
+[schedule]
+store = "~/.assay/schedules.json"
+```
+
+### 2. Run a test
+
+```bash
+assay run --target https://your-app.example.com
+```
+
+Exit codes: `0` = pass, `3` = fail, `1` = inconclusive or error.
+
+### 3. Start the ingest server
+
+```bash
+# Create an API key first
+assay key create --name ci
+
+# Start the server
+assay serve
+```
+
+### 4. Schedule recurring runs
+
+```bash
+# Add a schedule (standard 5-field cron)
+assay schedule add --cron "0 8 * * *" --suite smoke --target https://your-app.example.com
+
+# List schedules
+assay schedule list
+
+# Start the scheduler (foreground; Ctrl+C to stop)
+assay schedule run
+
+# Remove a schedule
+assay schedule remove <id>
+```
+
+## Browser SDK
+
+Install the TypeScript SDK in your web app:
+
+```bash
+npm install assay-sdk
+```
+
+```typescript
+import { AssaySDK } from "assay-sdk";
+
+const sdk = new AssaySDK({
+  apiKey: "your-api-key",
+  endpoint: "http://localhost:8000",
+});
+
+// Capture a screenshot + metadata and POST to /ingest
+await sdk.capture({ comment: "Optional human note" });
+```
+
+## Docker Runner
+
+The `assay run` command requires a pre-built Docker image containing Playwright.
+
+### Build locally
+
+```bash
+cd runner
+docker build -t assay-playwright:latest .
+```
+
+### Use a custom image
+
+Set `docker_image` in `assay.toml`:
+
+```toml
+[runner]
+docker_image = "myregistry.example.com/assay-playwright:latest"
+```
+
+Or override per-run (future flag — not yet wired in v0.1).
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/assay
+```
+
+## License
+
+MIT

assay_kit-0.1.0/README.md

@@ -0,0 +1,147 @@
+# Assay
+
+Independent verification layer for software projects. Assay runs Playwright-based browser tests in Docker, captures screenshots and results, formats them as structured task packets, and delivers them to a Grain workflow via the ingest API.
+
+## Requirements
+
+- Python 3.11+
+- Docker (for `assay run`)
+- Node.js 18+ (for the TypeScript browser SDK)
+
+## Install
+
+```bash
+pip install assay-kit
+```
+
+Or from source:
+
+```bash
+git clone <repo>
+cd assay
+pip install -e .
+```
+
+## Quick Start
+
+### 1. Configure
+
+Create `assay.toml` in your project root (all fields optional — defaults shown):
+
+```toml
+[project]
+name = "my-project"
+
+[runner]
+docker_image = "assay-playwright:latest"
+timeout_seconds = 300
+
+[output]
+directory = "./assay-output"
+
+[serve]
+host = "127.0.0.1"
+port = 8000
+
+[keys]
+store = "~/.assay/keys.json"
+
+[schedule]
+store = "~/.assay/schedules.json"
+```
+
+### 2. Run a test
+
+```bash
+assay run --target https://your-app.example.com
+```
+
+Exit codes: `0` = pass, `3` = fail, `1` = inconclusive or error.
+
+### 3. Start the ingest server
+
+```bash
+# Create an API key first
+assay key create --name ci
+
+# Start the server
+assay serve
+```
+
+### 4. Schedule recurring runs
+
+```bash
+# Add a schedule (standard 5-field cron)
+assay schedule add --cron "0 8 * * *" --suite smoke --target https://your-app.example.com
+
+# List schedules
+assay schedule list
+
+# Start the scheduler (foreground; Ctrl+C to stop)
+assay schedule run
+
+# Remove a schedule
+assay schedule remove <id>
+```
+
+## Browser SDK
+
+Install the TypeScript SDK in your web app:
+
+```bash
+npm install assay-sdk
+```
+
+```typescript
+import { AssaySDK } from "assay-sdk";
+
+const sdk = new AssaySDK({
+  apiKey: "your-api-key",
+  endpoint: "http://localhost:8000",
+});
+
+// Capture a screenshot + metadata and POST to /ingest
+await sdk.capture({ comment: "Optional human note" });
+```
+
+## Docker Runner
+
+The `assay run` command requires a pre-built Docker image containing Playwright.
+
+### Build locally
+
+```bash
+cd runner
+docker build -t assay-playwright:latest .
+```
+
+### Use a custom image
+
+Set `docker_image` in `assay.toml`:
+
+```toml
+[runner]
+docker_image = "myregistry.example.com/assay-playwright:latest"
+```
+
+Or override per-run (future flag — not yet wired in v0.1).
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/assay
+```
+
+## License
+
+MIT

assay_kit-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "assay-kit"
+version = "0.1.0"
+description = "Independent verification layer for software projects"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "Shaznay Sison" }]
+keywords = ["testing", "verification", "playwright", "automation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "apscheduler>=3.10",
+    "bcrypt>=4.1",
+    "fastapi>=0.111",
+    "jsonschema>=4.23",
+    "typer>=0.12",
+    "uvicorn>=0.29",
+]
+
+[project.scripts]
+assay = "assay.cli.main:app"
+
+[project.optional-dependencies]
+dev = [
+    "httpx>=0.27",
+    "mypy",
+    "pytest",
+    "ruff",
+]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+src = ["src"]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.mypy]
+strict = true
+packages = ["assay"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

assay_kit-0.1.0/setup.cfg

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

assay_kit-0.1.0/src/assay/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("assay-kit")
+except PackageNotFoundError:
+    __version__ = "0.0.0+dev"