Skip to main content

A protocol and tools for defining and working with criteria sets

Project description

Openframe ApS

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
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

openframe_criteria_set_protocol-2.6.0a3.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file openframe_criteria_set_protocol-2.6.0a3.tar.gz.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0a3.tar.gz
Algorithm Hash digest
SHA256 92114c81e0646a4df78f328da643307f9ccb3d31c6a95a25deafa6147b608a18
MD5 e84ade9b1ddbe14b110df7d25eb9adf0
BLAKE2b-256 fef83aa8d66c9130890efa6b6ef8e53044950afd18dfa842168c8e24e885a425

See more details on using hashes here.

File details

Details for the file openframe_criteria_set_protocol-2.6.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_criteria_set_protocol-2.6.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 1a32ab11d84c3f9a84871e752a0a04788bf3b953e048fcbeefc226f360e0e4f3
MD5 6740725cd9159cfce18b3f1a84e92717
BLAKE2b-256 0dc7b9ef0b3763948bd07c56cd674f49e2ea93c2d8cf89fe007e5968f59c18a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page