runmark 0.2.1__tar.gz → 0.2.2__tar.gz

{runmark-0.2.1/src/runmark.egg-info → runmark-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runmark
-Version: 0.2.1
+Version: 0.2.2
 Summary: Know what makes your code run. Local-first development environment observability, fingerprinting, comparison, and verification.
 Author: Runmark Maintainers
 License: MIT

{runmark-0.2.1 → runmark-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "runmark"
-version = "0.2.1"
+version = "0.2.2"
 description = "Know what makes your code run. Local-first development environment observability, fingerprinting, comparison, and verification."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -48,6 +48,9 @@ runmark = "runmark.cli.app:main"
 [tool.setuptools.packages.find]
 where = ["src"]
 
+[tool.setuptools.package-data]
+runmark = ["schemas/*.json", "py.typed"]
+
 [tool.ruff]
 line-length = 100
 target-version = "py310"

{runmark-0.2.1 → runmark-0.2.2}/src/runmark/__init__.py

@@ -3,5 +3,5 @@
 Local-first development environment observability, fingerprinting, comparison, and verification.
 """
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 __schema_version__ = "1.0"

{runmark-0.2.1 → runmark-0.2.2}/src/runmark/contracts/validator.py

@@ -10,7 +10,18 @@ import jsonschema  # type: ignore[import-untyped]
 from runmark.contracts.version_constraints import VersionConstraint
 from runmark.models.contract import RunmarkContract
 
-SCHEMA_FILE = Path(__file__).resolve().parent.parent.parent.parent / "schemas" / "contract-v1.json"
+def _get_schema_file(filename: str = "contract-v1.json") -> Path:
+    """Resolve schema file from package data or repository root."""
+    pkg_schema = Path(__file__).resolve().parent.parent / "schemas" / filename
+    if pkg_schema.exists():
+        return pkg_schema
+    repo_schema = Path(__file__).resolve().parent.parent.parent.parent / "schemas" / filename
+    if repo_schema.exists():
+        return repo_schema
+    return pkg_schema
+
+
+SCHEMA_FILE = _get_schema_file("contract-v1.json")
 
 VALID_OS_NAMES = {"windows", "linux", "darwin", "macos", "freebsd", "openbsd"}
 VALID_ARCHITECTURES = {"amd64", "x86_64", "arm64", "aarch64", "x86", "i386", "i686"}
@@ -30,9 +41,10 @@ class ContractValidator:
     def get_schema(cls) -> dict[str, Any]:
         """Load and cache contract-v1.json schema."""
         if cls._cached_schema is None:
-            if not SCHEMA_FILE.exists():
-                raise FileNotFoundError(f"Schema file not found at: {SCHEMA_FILE}")
-            with open(SCHEMA_FILE, encoding="utf-8") as f:
+            schema_file = _get_schema_file("contract-v1.json")
+            if not schema_file.exists():
+                raise FileNotFoundError(f"Schema file not found at: {schema_file}")
+            with open(schema_file, encoding="utf-8") as f:
                 cls._cached_schema = json.load(f)
         return cls._cached_schema
 

runmark-0.2.2/src/runmark/schemas/contract-v1.json

@@ -0,0 +1,168 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://runmark.dev/schemas/contract-v1.json",
+  "title": "RunmarkContract",
+  "description": "Formal schema for defining development environment requirements in runmark.json.",
+  "type": "object",
+  "required": ["version"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "Informational URI/path pointing to the contract schema."
+    },
+    "version": {
+      "type": "integer",
+      "enum": [1],
+      "description": "Contract format version (must be 1 for contract-v1)."
+    },
+    "project": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Expected project name."
+        }
+      }
+    },
+    "platform": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "os": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Supported operating systems (e.g. ['windows', 'linux', 'darwin'])."
+        },
+        "architecture": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Supported hardware architectures (e.g. ['amd64', 'arm64', 'x86_64'])."
+        }
+      }
+    },
+    "runtime": {
+      "type": "object",
+      "description": "Required runtimes mapped to version constraint expressions (e.g. 'python': '3.12.x').",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "dependencies": {
+      "type": "object",
+      "description": "Required package dependencies categorized by ecosystem.",
+      "additionalProperties": false,
+      "properties": {
+        "python": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        },
+        "node": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        }
+      }
+    },
+    "services": {
+      "type": "object",
+      "description": "Required or optional backing services (e.g. postgresql, redis).",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "string",
+            "description": "Version constraint string (defaults to required: true)."
+          },
+          {
+            "type": "object",
+            "required": ["version"],
+            "additionalProperties": false,
+            "properties": {
+              "version": {
+                "type": "string",
+                "description": "Expected version constraint for the service."
+              },
+              "required": {
+                "type": "boolean",
+                "default": true,
+                "description": "Whether the service is mandatory (true) or optional (false)."
+              }
+            }
+          }
+        ]
+      }
+    },
+    "environment": {
+      "type": "object",
+      "description": "Declared environment variable requirements (names only).",
+      "additionalProperties": false,
+      "properties": {
+        "required": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "List of variable names that must be present."
+        },
+        "optional": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "List of optional variable names."
+        }
+      }
+    },
+    "network": {
+      "type": "object",
+      "description": "Network and port requirements.",
+      "additionalProperties": false,
+      "properties": {
+        "ports": {
+          "type": "object",
+          "description": "Mapping of port numbers to network requirement specifications.",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "protocol": {
+                "type": "string",
+                "enum": ["tcp", "udp"],
+                "default": "tcp",
+                "description": "Port transport protocol."
+              },
+              "required": {
+                "type": "boolean",
+                "default": true,
+                "description": "Whether this port availability is required."
+              }
+            }
+          }
+        }
+      }
+    },
+    "containers": {
+      "type": "object",
+      "description": "Container runtime requirements.",
+      "additionalProperties": false,
+      "properties": {
+        "docker": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "required": {
+              "type": "boolean",
+              "default": true
+            }
+          }
+        },
+        "compose": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "required": {
+              "type": "boolean",
+              "default": true
+            }
+          }
+        }
+      }
+    }
+  }
+}

runmark-0.2.2/src/runmark/schemas/runmark-v1.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://runmark.dev/schemas/runmark-v1.json",
+  "title": "RunmarkState",
+  "description": "Canonical schema representing the captured state of a software project development environment.",
+  "type": "object",
+  "required": [
+    "runmark",
+    "project",
+    "git",
+    "system",
+    "runtimes",
+    "dependencies",
+    "services",
+    "environment",
+    "network",
+    "containers"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "runmark": {
+      "type": "object",
+      "required": ["id", "created_at", "tool_version", "schema_version", "environment_fingerprint"],
+      "additionalProperties": false,
+      "properties": {
+        "id": { "type": "string" },
+        "created_at": { "type": "string", "format": "date-time" },
+        "tool_version": { "type": "string" },
+        "schema_version": { "type": "string" },
+        "environment_fingerprint": { "type": "string" },
+        "message": { "type": ["string", "null"] }
+      }
+    },
+    "project": {
+      "type": "object",
+      "required": ["name", "root", "languages", "frameworks", "package_managers", "containerization"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string" },
+        "root": { "type": "string" },
+        "languages": { "type": "array", "items": { "type": "string" } },
+        "frameworks": { "type": "array", "items": { "type": "string" } },
+        "package_managers": { "type": "array", "items": { "type": "string" } },
+        "containerization": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "git": {
+      "type": "object",
+      "required": ["is_repository", "branch", "commit", "dirty"],
+      "additionalProperties": false,
+      "properties": {
+        "is_repository": { "type": "boolean" },
+        "branch": { "type": ["string", "null"] },
+        "commit": { "type": ["string", "null"] },
+        "dirty": { "type": "boolean" }
+      }
+    },
+    "system": {
+      "type": "object",
+      "required": ["os_name", "os_version", "architecture"],
+      "additionalProperties": false,
+      "properties": {
+        "os_name": { "type": "string" },
+        "os_version": { "type": "string" },
+        "architecture": { "type": "string" }
+      }
+    },
+    "runtimes": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "required": ["name", "installed", "version", "status"],
+        "additionalProperties": false,
+        "properties": {
+          "name": { "type": "string" },
+          "installed": { "type": "boolean" },
+          "version": { "type": ["string", "null"] },
+          "status": { "type": "string", "enum": ["detected", "not_found", "not_applicable", "unsupported", "error"] },
+          "executable_path": { "type": ["string", "null"] }
+        }
+      }
+    },
+    "dependencies": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "manager", "declared", "resolved", "kind"],
+        "additionalProperties": false,
+        "properties": {
+          "name": { "type": "string" },
+          "manager": { "type": "string" },
+          "declared": { "type": ["string", "null"] },
+          "resolved": { "type": ["string", "null"] },
+          "kind": { "type": "string", "enum": ["direct", "transitive", "dev", "peer", "unknown"] }
+        }
+      }
+    },
+    "services": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "installed", "running", "detected_version", "expected_version", "status", "port"],
+        "additionalProperties": false,
+        "properties": {
+          "name": { "type": "string" },
+          "installed": { "type": "boolean" },
+          "running": { "type": "boolean" },
+          "detected_version": { "type": ["string", "null"] },
+          "expected_version": { "type": ["string", "null"] },
+          "status": { "type": "string", "enum": ["detected", "not_found", "not_applicable", "unsupported", "error"] },
+          "port": { "type": ["integer", "null"] }
+        }
+      }
+    },
+    "environment": {
+      "type": "object",
+      "required": ["variables"],
+      "additionalProperties": false,
+      "properties": {
+        "variables": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "required": ["name", "required", "present", "secret", "source"],
+            "additionalProperties": false,
+            "properties": {
+              "name": { "type": "string" },
+              "required": { "type": "boolean" },
+              "present": { "type": "boolean" },
+              "secret": { "type": "boolean" },
+              "source": { "type": "string" }
+            }
+          }
+        }
+      }
+    },
+    "network": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["port", "service", "expected", "occupied", "status"],
+        "additionalProperties": false,
+        "properties": {
+          "port": { "type": "integer" },
+          "service": { "type": "string" },
+          "expected": { "type": "boolean" },
+          "occupied": { "type": "boolean" },
+          "status": { "type": "string" }
+        }
+      }
+    },
+    "containers": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["service_name", "image", "tag", "running_status"],
+        "additionalProperties": false,
+        "properties": {
+          "service_name": { "type": "string" },
+          "image": { "type": "string" },
+          "tag": { "type": ["string", "null"] },
+          "running_status": { "type": "string" }
+        }
+      }
+    }
+  }
+}

{runmark-0.2.1 → runmark-0.2.2/src/runmark.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runmark
-Version: 0.2.1
+Version: 0.2.2
 Summary: Know what makes your code run. Local-first development environment observability, fingerprinting, comparison, and verification.
 Author: Runmark Maintainers
 License: MIT

{runmark-0.2.1 → runmark-0.2.2}/src/runmark.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 src/runmark/__init__.py
 src/runmark/__main__.py
+src/runmark/py.typed
 src/runmark.egg-info/PKG-INFO
 src/runmark.egg-info/SOURCES.txt
 src/runmark.egg-info/dependency_links.txt
@@ -93,6 +94,9 @@ src/runmark/output/json.py
 src/runmark/output/markdown.py
 src/runmark/output/tables.py
 src/runmark/output/terminal.py
+src/runmark/schemas/__init__.py
+src/runmark/schemas/contract-v1.json
+src/runmark/schemas/runmark-v1.json
 src/runmark/security/__init__.py
 src/runmark/security/contract_sanitizer.py
 src/runmark/security/export_sanitizer.py