A protocol and tools for defining and working with criteria sets
Project description
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 |
|
Quality |
|
QualityStyle |
|
Color |
|
RgbColor |
|
Task tree types | |
CriteriaTree |
|
Criterion |
|
TaskGroup |
|
Task |
|
TaskItem |
|
TaskItem value types | |
SelectSingleType |
|
SelectMultipleType |
|
NumberType |
|
BooleanType |
|
PointOption |
Used by SelectSingleType and SelectMultipleType |
TaskItemValue |
The raw value of a TaskItem, which can be an array |
TaskItemScalarValue |
The raw value of a TaskItem |
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for openframe-criteria-set-protocol-1.0.63.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb8b5e5815a4817c60af1a404a76f8ab1134b71fdd395177e571f1b6a44d3f7e |
|
MD5 | e4d8488e3eab46d845e3551c4d33788c |
|
BLAKE2b-256 | b944da97bbbcaf1e9197ad70cda48617bec92741d6708547dedbbdedb6527c68 |
Close
Hashes for openframe_criteria_set_protocol-1.0.63-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9bad654abac5cdcce43577dbca84c2e1e1414f9dcc2f3bd9049f5affaaaae82 |
|
MD5 | 38ee06f52a0fdfd832550b2ded15cba6 |
|
BLAKE2b-256 | e3da16cfdb58124b9847ed14913a33fee39f437c8c9a3a1d6cfe0e69cdc9a5e9 |