openframe-criteria-set-protocol 2.7.3

A protocol and tools for defining and working with criteria sets

Criteria Set Protocol

Python library

This is a Python library with types and implementations of the Criteria Set Protocol. It is published publicly on PyPI as openframe-criteria-set-protocol.

Installation

pip install openframe-criteria-set-protocol

Contents

Protocol v1

The library contains the types defined in the protocol v1 specification.

Types

Type	Remarks
Metadata types
Metadata
Theme
ThemeStyle
Color
RgbColor
Task tree types
CriteriaTree
Criterion
TaskGroup
Task
TaskItem
TaskItem value types
SelectSingleType
SelectMultipleType
NumberType
BooleanType
PointOption	Used by SelectSingleType and SelectMultipleType
TaskItemValueReference	The raw value reference of a TaskItem
TaskItemValueReferenceMap	A map of TaskItem value references
REST types
MetadataResponse	Metadata endpoint response body
StreamCriteriaSetMatrixBody	Request body for the matrix streaming endpoints
StreamMatrixResponse	Matrix streaming endpoints response body

Schemas

Validation schemas are provided for validating the endpoints of the protocol v1 specification.

Schema	Remarks
criteria_set_id	Regular expression for the criteria_set_id parameter for endpoints which use it
version	Regular expression for the version parameter for endpoints which use it
marshmallow schemas
TreeAndMatrixBodySchema	Schema for validating the request body for tree and matrix endpoints

Deployment

Deploy using the following commands:

python3 -m build
python3 -m twine upload dist/*

License

Openframe Criteria Set Protocol by Openframe ApS is licensed under CC BY-ND 4.0