scrollcase-consumer 0.1.0

Verify, prepare, and run caller-supplied local Scrollcase boxes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://scrollcase.dev/schema/v2/box-manifest.schema.json",
  "title": "Box manifest (box.json)",
  "description": "The manifest packed inside the archive at box.json. It restates the box's identity, layout and provenance so an extracted box is self-describing: a consumer that has the directory but not the release document can still tell what it is holding and how it was built.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "boxId",
    "modelId",
    "runtimeId",
    "version",
    "target",
    "pythonEntryPoint",
    "modelCacheSubdir",
    "selfTest",
    "provenance"
  ],
  "properties": {
    "schemaVersion": {
      "const": 2
    },
    "boxId": {
      "type": "string",
      "minLength": 1
    },
    "modelId": {
      "type": "string",
      "minLength": 1
    },
    "runtimeId": {
      "type": "string",
      "minLength": 1
    },
    "version": {
      "type": "string",
      "minLength": 1
    },
    "target": {
      "$ref": "https://scrollcase.dev/schema/v2/target.schema.json"
    },
    "pythonEntryPoint": {
      "type": "string",
      "minLength": 1
    },
    "modelCacheSubdir": {
      "type": "string",
      "minLength": 1
    },
    "environment": {
      "type": "object",
      "description": "Environment variables repeated from the signed release. Scrollcase consumers compare this declaration before execution and apply it over inherited and caller-supplied values.",
      "propertyNames": {
        "minLength": 1,
        "pattern": "^[^=\\u0000]+$"
      },
      "additionalProperties": {
        "type": "string",
        "pattern": "^[^\\u0000]*$"
      }
    },
    "selfTest": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "pythonImports",
        "timeoutSeconds"
      ],
      "properties": {
        "pythonImports": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "timeoutSeconds": {
          "type": "integer",
          "exclusiveMinimum": 0
        }
      }
    },
    "execution": {
      "$ref": "https://scrollcase.dev/schema/v2/execution.schema.json"
    },
    "provenance": {
      "$ref": "https://scrollcase.dev/schema/v2/release-manifest.schema.json#/$defs/provenance"
    },
    "weights": {
      "const": "on-demand",
      "description": "Present only when the assets were deliberately left out of the archive. Absent means the box is self-contained: everything it needs is inside it."
    },
    "assets": {
      "type": "array",
      "minItems": 1,
      "description": "Assets the consumer must fetch and place under the box root before first use. Present only with on-demand weights. The declared hash is what makes fetching them safe.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "url",
          "relativePath",
          "sizeBytes",
          "sha256"
        ],
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1
          },
          "relativePath": {
            "type": "string",
            "minLength": 1
          },
          "sizeBytes": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "sha256": {
            "$ref": "https://scrollcase.dev/schema/v2/release-manifest.schema.json#/$defs/sha256"
          }
        }
      }
    }
  },
  "dependentRequired": {
    "assets": [
      "weights"
    ],
    "weights": [
      "assets"
    ]
  }
}